versia-pub/server
2
0
Fork 0
mirror of https://github.com/versia-pub/server.git synced 2026-01-26 12:16:01 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: 📝 Update docs

Browse source
This commit is contained in:
Jesse Wierzbinski 2024-05-06 18:26:56 +00:00
parent c22158c687
commit 2f578de01a
No known key found for this signature in database
1 changed files with 3 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/installation.md
View file

@ -1,13 +1,8 @@
# Installation # Installation
> [!NOTE]
> You should probably be using the `main` branch of this repository, as it is the most up-to-date. When 0.5 releases, you should switch to the `0.5` branch.
>
> For Docker, this means pulling the `main` tag
### Requirements ### Requirements
- The [Bun Runtime](https://bun.sh), version 1.0.30 or later (usage of the latest version is recommended) - The [Bun Runtime](https://bun.sh), version 1.1.7 or later (usage of the latest version is recommended)
- A PostgreSQL database - A PostgreSQL database
- (Optional but recommended) A Linux-based operating system - (Optional but recommended) A Linux-based operating system
- (Optional if you want search) A working Meiliseach instance - (Optional if you want search) A working Meiliseach instance
@ -17,9 +12,9 @@
> >
> We will not be offerring support to Windows or MacOS users. If you are using one of these operating systems, please use a virtual machine or container to run Lysand. > We will not be offerring support to Windows or MacOS users. If you are using one of these operating systems, please use a virtual machine or container to run Lysand.
### With Docker ### With Docker/Podman
Docker is the recommended way to run Lysand (podman should also work). To run Lysand with Docker, follow these steps: Docker is the recommended way to run Lysand (podman also works). To run Lysand with Docker, follow these steps:
1. Download the `docker-compose.yml` file from the repository 1. Download the `docker-compose.yml` file from the repository