versia-pub/server
2
0
Fork 0
mirror of https://github.com/versia-pub/server.git synced 2025-12-08 09:18:19 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: 📝 Update some outdated documentation info

Browse source
This commit is contained in:
Jesse Wierzbinski 2024-06-14 00:02:33 -10:00
parent 731fc9847c
commit a0d56c044b
No known key found for this signature in database
2 changed files with 8 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/database.md
View file

@ -5,6 +5,3 @@ Lysand uses a special PostgreSQL extension called `pg_uuidv7` to generate UUIDs.
## Using the Docker image ## Using the Docker image
Lysand offers a pre-made Docker image for PostgreSQL with the extension already installed. Use `ghcr.io/lysand-org/postgres:main` as your Docker image name to use it. Lysand offers a pre-made Docker image for PostgreSQL with the extension already installed. Use `ghcr.io/lysand-org/postgres:main` as your Docker image name to use it.
## Manual installation

14
docs/installation.md
View file

@ -59,19 +59,19 @@ bun install
1. Set up a PostgreSQL database (you need a special extension, please look at [the database documentation](database.md)) 1. Set up a PostgreSQL database (you need a special extension, please look at [the database documentation](database.md))
2. (If you want search) 2. (If you want search)
Create a Meilisearch instance (using Docker is recommended). For a [`docker-compose`] file, copy the `meilisearch` service from the [`docker-compose.yml`](docker-compose.yml) file. Create a Meilisearch instance (using Docker is recommended). For a [`docker-compose`] file, copy the `meilisearch` service from the [`docker-compose.yml`](../docker-compose.yml) file.
Set up Meiliseach's API key by passing the `MEILI_MASTER_KEY` environment variable to the server. Then, enable and configure search in the config file. 1. Build everything:
3. Build everything:
```bash ```bash
bun prod-build bun run build
``` ```
4. Copy the `config.toml.example` file to `config.toml` inside `dist/config/` and fill in the values (you can leave most things to the default, but you will need to configure things such as the database connection) 4. Copy the `config.example.toml` file to `config.toml` inside `dist/config/` and fill in the values (you can leave most things to the default, but you will need to configure things such as the database connection)
You may now start the server with `bun start`. It lives in the `dist/` directory, all the other code can be removed from this point onwards. CD to the `dist/` directory: `cd dist`
You may now start the server with `bun run cli/index.js start`. It lives in the `dist/` directory, all the other code can be removed from this point onwards.
## Running the Server ## Running the Server