Skip to content

Latest commit

 

History

History
136 lines (90 loc) · 4.07 KB

README.md

File metadata and controls

136 lines (90 loc) · 4.07 KB
Raw

Voltaserve

The Cloud Storage for Content Creators

  • Open gigabyte-large images in seconds and enjoy buttery smooth zooming in and out.
  • Extract valuable insights from documents or scans using powerful AI.
  • Stream audio and video effortlessly.
  • Protect your sensitive documents with a watermark.
  • Upload and preview nearly any file type without needing a dedicated app.
  • Create groups and organizations, assign permissions, and collaborate in real-time with your team.

Getting Started

Pull images: (recommended for most users)

docker compose pull

Or, alternatively you can build the images from the source:

Build images:

docker compose build

Start containers:

docker compose up -d

Wait until the following containers are running:

  • voltaserve-api
  • voltaserve-idp
  • voltaserve-conversion
  • voltaserve-webdav
  • voltaserve-language
  • voltaserve-mosaic
  • voltaserve-ui

You can check that by running the command docker ps and look at the STATUS column.

  1. Go to the sign up page http://localhost:3000/sign-up and create an account.

  2. Open MailCatcher http://localhost:8025, select the received email and click the confirm email link.

  3. Finally, go to the sign in page http://localhost:3000/sign-in and login with your credentials.

Connect with WebDAV

Voltaserve supports WebDAV, by default it's using the port 8082.

To connect you can use Mountainduck, Cyberduck, WinSCP, Owlfiles or Rclone.

Configuration

Update the VOLTASERVE_HOSTNAME environment variable in .env file to match your hostname (it can optionally be an IP address as well):

VOLTASERVE_HOSTNAME="my-hostname"

Update the following environment variables in .env file to match your SMTP server:

VOLTASERVE_SMTP_HOST="my-smtp-hostname"
VOLTASERVE_SMTP_PORT=587
VOLTASERVE_SMTP_SECURE=true
VOLTASERVE_SMTP_USERNAME="my-smtp-user"
VOLTASERVE_SMTP_PASSWORD="my-smtp-password"
VOLTASERVE_SMTP_SENDER_ADDRESS="no-reply@my-domain"
VOLTASERVE_SMTP_SENDER_NAME="Voltaserve"

The port 3000 is used for the UI, therefore it needs to be open and accessible from the outside. One way of doing it in Linux is by using ufw:

sudo ufw allow 3000

You can change the UI port to something else, other than 3000, like 80 for example. This can be done by editing the VOLTASERVE_UI_PORT environment variable in .env file as follows:

VOLTASERVE_UI_PORT=80

The port 8082 is used for WebDAV, you can change it by editing the VOLTASERVE_WEBDAV_PORT environment variable in .env file as follows:

VOLTASERVE_WEBDAV_PORT=8082

The port needs to be open and accessible from the outside. One way of doing it in Linux is by using ufw:

sudo ufw allow 8082

Other ports can be changed as well by editing their respective environment variables in .env file.

Troubleshooting

My containers have issues starting up, what should I do?

One reason might be that some ports are already allocated on your machine, in this case you can change the Voltaserve ports in .env file.

I'm not happy with localhost, can I change it?

You can achieve this by changing the VOLTASERVE_HOSTNAME environment variable in .env file.

It can be any IP address, like:

VOLTASERVE_HOSTNAME="192.168.1.100"

Or any custom hostname, like:

VOLTASERVE_HOSTNAME="my-hostname"

Development

To setup a development environment for the purpose of developing and debugging Voltaserve, please read the development documentation available here.

Licensing

Voltaserve is released under the GNU Affero General Public License v3.0.