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

docs: 📝 Clarify installation pitfalls

Browse source
This commit is contained in:
Jesse Wierzbinski 2024-07-22 21:02:41 +02:00
parent f3902f8c7b
commit 0645203d97
No known key found for this signature in database
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/installation.md
View file

@ -22,6 +22,11 @@ Docker is the recommended way to run Lysand (Podman also works). To run Lysand w
> [!NOTE] > [!NOTE]
> You may need to change the image from `ghcr.io/lysand-org/lysand:latest` to `ghcr.io/lysand-org/lysand: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. > You may need to change the image from `ghcr.io/lysand-org/lysand:latest` to `ghcr.io/lysand-org/lysand: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.
> [!CAUTION]
> The `latest` tag on the Docker image refers to the latest release (currently `v0.6.0`), not the latest commit on the `main` branch.
>
> **Do not mix configurations from different branches, or everything will break with confusing errors!**
```bash ```bash
curl -o docker-compose.yml https://raw.githubusercontent.com/lysand-org/lysand/main/docker-compose.yml curl -o docker-compose.yml https://raw.githubusercontent.com/lysand-org/lysand/main/docker-compose.yml
``` ```
@ -29,7 +34,10 @@ curl -o docker-compose.yml https://raw.githubusercontent.com/lysand-org/lysand/m
2. Download the `config.example.toml` file from the repository 2. Download the `config.example.toml` file from the repository
```bash ```bash
# From main branch
curl -o config.example.toml https://raw.githubusercontent.com/lysand-org/lysand/main/config/config.example.toml curl -o config.example.toml https://raw.githubusercontent.com/lysand-org/lysand/main/config/config.example.toml
# For a specific release (e.g. v0.6.0)
curl -o config.example.toml https://raw.githubusercontent.com/lysand-org/lysand/v0.6.0/config/config.example.toml
``` ```
4. 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) 4. 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)
5. Run the following command to start the server: 5. Run the following command to start the server: