Installing Savee¶

Running the App¶

If the server is set up correctly and ready for use, you can move on to installing the Savee application.

Installation Directory¶

We recommend installing Savee to the /srv directory. To navigate there, use this command:

cd /srv

Cloning the GitLab Repo¶

Once in your desired directory, clone Savee from our GitLab repository by entering:

git clone https://gitlab.nikatron.cz/nikatron/software/savee.git

Savee Directory¶

Cloning the GitLab repository creates a savee folder in the directory you are located in. Navigate to this new folder by typing:

cd savee

Starting the Container¶

Finally, just enter this Docker command to download and run the Savee application:

docker compose up -d

And that's it! You have successfully started the Savee application on your server.

Verifying the Status¶

You can verify if Savee is working by running:

docker ps

This will show all of Docker's running containers. If you see at least these four containers:

• savee-proxy-1
• savee-webapp-1
• savee-api-1
• savee-mongo-1

then that means your Savee application is healthy and running on your server's IP address.

Updating Savee¶

If you already have Savee installed and running on your server, updating the application is a simple and safe process. Updates typically include new features, improved stability, and security fixes — so it is recommended to keep your application up to date.

Before you begin, ensure that:

• Your server is functioning correctly
• Docker and Docker Compose are installed and running
• You have access to the folder where Savee is installed

Savee Directory¶

First, move into the directory where Savee is located:

cd /srv/savee

Stopping the App¶

Before applying updates, it is best to stop all running containers to prevent conflicts:

docker compose down

This ensures that the application is shut down cleanly and that no files or database layers are locked during the update.

Pulling the Latest Version¶

To download the newest version of Savee, simply pull the latest changes from the repository:

git pull

This will update the existing files without removing your configuration or data.

Restarting the App¶

After pulling the latest code, restarting the application will make docker pull the latest Savee version:

docker compose up -d

docker ps

If all of the steps above have been successful, then the Savee application is updated.

Uninstalling the App¶

Savee Directory¶

To uninstall the Savee application from your server, start by navigating the the directory where Savee is installed:

cd /srv/savee

Stopping the App¶

Once in the directory where Savee is located, stop the app by running:

docker compose down

Removing Volumes¶

Then, you need to remove Savee's Docker volumes. To list out all Docker volumes, use:

docker volume ls

This will show you all Docker volumes on your server. If you have Savee installed, there should be one named SAVEE_SAVEE_DATA. Remove the volume by entering:

docker volume rm ${volume_name}

Removing Images¶

Finally, it is recommended to also remove Savee's Docker images. This prevents Docker using these old images in the case of reinstalling Savee in the future, after a new version of the app has been released. You can achieve deletion of these images in a similar way as with the volumes:

docker image ls

This lists every docker image. Remove these four

• registry.nikatron.com/savee/proxy
• registry.nikatron.com/savee/webapp
• registry.nikatron.com/savee/api
• mongo

by using:

docker image rm ${image_name}