versia-pub/server
2
0
Fork 0
mirror of https://github.com/versia-pub/server.git synced 2025-12-06 16:38:19 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
server/docs/setup/installation.md
Jesse Wierzbinski e6c7e8a597
Some checks failed
CodeQL Scan / Analyze (javascript-typescript) (push) Failing after 5s
Details
Build Docker Images / lint (push) Failing after 10s
Details
Build Docker Images / check (push) Failing after 10s
Details
Build Docker Images / tests (push) Failing after 6s
Details
Build Docker Images / build (server, Dockerfile, ${{ github.repository_owner }}/server) (push) Has been skipped
Details
Build Docker Images / build (worker, Worker.Dockerfile, ${{ github.repository_owner }}/worker) (push) Has been skipped
Details
Deploy Docs to GitHub Pages / build (push) Failing after 5s
Details
Deploy Docs to GitHub Pages / Deploy (push) Has been skipped
Details
Mirror to Codeberg / Mirror (push) Failing after 0s
Details
Nix Build / check (push) Failing after 5s
Details
docs: 📝 Remove support for from-source installs
2025-02-15 18:49:31 +01:00

2.4 KiB
Raw Blame History

Installation

Requirements

  • A Linux-based operating system. Kernel version 6.1 or later is recommended.
  • Basic knowledge of Docker and Docker Compose.

Installation

[!INFO]

Traditional "from-source" installation is not supported, as the server is designed to be run in a containerized environment. This guide will cover how to run the server using Docker.

You may still run the server without Docker, but I can't guarantee that it will work properly.

  1. Download the docker-compose.yml file from the repository

Note

You may need to change the image from ghcr.io/versia-pub/server:latest to ghcr.io/versia-pub/server:main if you want to use the latest changes from the main branch. Make sure to use the config template from the same branch as the server.

curl -o docker-compose.yml https://raw.githubusercontent.com/versia-pub/server/v0.7.0/docker-compose.yml
  1. Edit the docker-compose.yml file to set up the database connection and other settings
  2. Download the config.example.toml file from the repository
curl -o config.example.toml https://raw.githubusercontent.com/versia-pub/server/v0.7.0/config/config.example.toml
  1. Edit the config.example.toml file to set up the database connection and other settings, rename it to config.toml, then place it inside config/ (create the config/ directory if it does not exist)
  2. Run the following command to start the server:

Warning

The first time you start the server, it will complain about missing keys in the configuration file.

These will be autogenerated and printed to the console, so you can copy them to your config.toml file.

docker compose up

You may need root privileges to run Docker commands.

To check server logs, run docker compose logs versia. The server will likely stop if there is an error, so you can check the logs to see what went wrong.

Running the Server

Database migrations are run automatically on startup.

Please see the CLI documentation for more information on how to use the CLI.

Updating the server

Updating the server is as simple as running docker-compose pull to update the Docker images, then docker-compose up to restart the server.

Sometimes, new configuration options are added to config.example.toml. If you see a new option in the example file, you should add it to your config.toml file.