From a0d56c044b700b7c04305c787d907abc1090302c Mon Sep 17 00:00:00 2001 From: Jesse Wierzbinski Date: Fri, 14 Jun 2024 00:02:33 -1000 Subject: [PATCH] docs: :memo: Update some outdated documentation info --- docs/database.md | 5 +---- docs/installation.md | 14 +++++++------- 2 files changed, 8 insertions(+), 11 deletions(-) diff --git a/docs/database.md b/docs/database.md index 3de46f59..47bb84cc 100644 --- a/docs/database.md +++ b/docs/database.md @@ -4,7 +4,4 @@ Lysand uses a special PostgreSQL extension called `pg_uuidv7` to generate UUIDs. ## 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. - -## Manual installation - +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. \ No newline at end of file diff --git a/docs/installation.md b/docs/installation.md index 072ef72c..5f7e6811 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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)) 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. - -3. Build everything: +1. Build everything: ```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