From 166048479e8729e7642ec2b1bee12c25a7c70ac3 Mon Sep 17 00:00:00 2001 From: Jesse Wierzbinski Date: Wed, 1 May 2024 18:45:27 -1000 Subject: [PATCH] docs: :memo: Update docs --- README.md | 44 +------------------------------------------- docker-compose.yml | 16 ++++++++++++++-- docs/installation.md | 5 +++++ 3 files changed, 20 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index ce31763d..7f014eaa 100644 --- a/README.md +++ b/README.md @@ -30,49 +30,7 @@ This project aims to be a fully featured social network, with a focus on privacy ## Screenshots -Here are some screenshots of Lysand's built-in web client. This client is built with Nuxt, and serves to allow users to log in or register. It is kept to only the actions that cannot be done with a Mastodon client, to simplify development. In the future, there will be a full-featured client. - -### On Desktop - -#### Welcome Page - -![Welcome Page](assets/main.webp) - -#### Logging In - -![Logging In](assets/login.webp) - -#### OAuth Confirmation - -![OAuth Confirmation](assets/redirect.webp) - -#### Registration Page - -![Registration Page](assets/register.webp) - -#### Home Timeline - -![Home Timeline](assets/soapbox.webp) - -### On Mobile - -#### Logging In - -
- Logging In -
- -#### OAuth Confirmation - -
- OAuth Confirmation -
- -#### Registration Page - -
- Registration Page -
+You can visit [https://social.lysand.org](https://social.lysand.org) to see a live instance of Lysand with Lysand-FE. ## Benchmarks diff --git a/docker-compose.yml b/docker-compose.yml index 252440ed..b48a02f5 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,15 +1,27 @@ services: lysand: - build: . # Automatic builds are currently broken, please build from source - # image: ghcr.io/lysand-org/lysand:latest + build: ghcr.io/lysand-org/lysand:main volumes: - ./logs:/app/dist/logs - ./config:/app/dist/config - ./uploads:/app/dist/uploads + - ./glitch:/app/dist/glitch restart: unless-stopped container_name: lysand networks: - lysand-net + depends-on: + - db + - redis + - meilisearch + - fe + + fe: + image: ghcr.io/lysand-org/lysand-fe:main + container_name: lysand-fe + restart: unless-stopped + networks: + - lysand-net db: image: ghcr.io/lysand-org/postgres:main diff --git a/docs/installation.md b/docs/installation.md index 85d42d03..4dce5934 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,5 +1,10 @@ # 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 - The [Bun Runtime](https://bun.sh), version 1.0.30 or later (usage of the latest version is recommended)