refactor: 🚚 Use more Versia branding and assets

This commit is contained in:
Jesse Wierzbinski 2024-08-24 15:34:49 +02:00
parent 3d5a693d71
commit 832f72160f
No known key found for this signature in database
11 changed files with 78 additions and 78 deletions

View file

@ -2,7 +2,7 @@
Versia Server supports the use of the Glitch-Soc fork of Mastodon's frontend. Here's how to do it:
1. Download the latest Glitch FE package from [the releases page](https://github.com/lysand-org/lysand/releases) (it should be named `glitch.tar.gz` and be inside the assets of a normal Versia Server release).
1. Download the latest Glitch FE package from [the releases page](https://github.com/lysand-org/server/releases) (it should be named `glitch.tar.gz` and be inside the assets of a normal Versia Server release).
2. Extract the contents of the package into a folder, which you can name `glitch` for simplicity. (if using Docker, now is the time to mount that folder into the container, for example with `-v /path/to/glitch:/app/dist/glitch`)
3. Change the config to enable Glitch-FE:
```toml

View file

@ -20,7 +20,7 @@ Docker is the recommended way to run Versia Server (Podman also works). To run V
1. Download the `docker-compose.yml` file from the repository
> [!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/server:latest` to `ghcr.io/lysand-org/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.
> [!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.
@ -28,16 +28,16 @@ Docker is the recommended way to run Versia Server (Podman also works). To run V
> **Do not mix configurations from different branches, or everything will break with confusing errors!**
```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/server/main/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
```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/server/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
curl -o config.example.toml https://raw.githubusercontent.com/lysand-org/server/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)
5. Run the following command to start the server:
@ -58,7 +58,7 @@ To check server logs, run `docker compose logs lysand`. The server will likely s
1. Clone this repository
```bash
git clone https://github.com/lysand-org/lysand.git
git clone https://github.com/lysand-org/server.git
```
2. Install the dependencies