mirror of
https://github.com/versia-pub/server.git
synced 2025-12-06 16:38:19 +01:00
docs: 📝 Update docs
This commit is contained in:
parent
0baa9dd12d
commit
166048479e
44
README.md
44
README.md
|
|
@ -30,49 +30,7 @@ This project aims to be a fully featured social network, with a focus on privacy
|
||||||
|
|
||||||
## Screenshots
|
## 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.
|
You can visit [https://social.lysand.org](https://social.lysand.org) to see a live instance of Lysand with Lysand-FE.
|
||||||
|
|
||||||
### On Desktop
|
|
||||||
|
|
||||||
#### Welcome Page
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
#### Logging In
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
#### OAuth Confirmation
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
#### Registration Page
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
#### Home Timeline
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
### On Mobile
|
|
||||||
|
|
||||||
#### Logging In
|
|
||||||
|
|
||||||
<center>
|
|
||||||
<img src="assets/login_mobile.webp" alt="Logging In" width="300">
|
|
||||||
</center>
|
|
||||||
|
|
||||||
#### OAuth Confirmation
|
|
||||||
|
|
||||||
<center>
|
|
||||||
<img src="assets/redirect_mobile.webp" alt="OAuth Confirmation" width="300">
|
|
||||||
</center>
|
|
||||||
|
|
||||||
#### Registration Page
|
|
||||||
|
|
||||||
<center>
|
|
||||||
<img src="assets/register_mobile.webp" alt="Registration Page" width="300">
|
|
||||||
</center>
|
|
||||||
|
|
||||||
## Benchmarks
|
## Benchmarks
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,15 +1,27 @@
|
||||||
services:
|
services:
|
||||||
lysand:
|
lysand:
|
||||||
build: . # Automatic builds are currently broken, please build from source
|
build: ghcr.io/lysand-org/lysand:main
|
||||||
# image: ghcr.io/lysand-org/lysand:latest
|
|
||||||
volumes:
|
volumes:
|
||||||
- ./logs:/app/dist/logs
|
- ./logs:/app/dist/logs
|
||||||
- ./config:/app/dist/config
|
- ./config:/app/dist/config
|
||||||
- ./uploads:/app/dist/uploads
|
- ./uploads:/app/dist/uploads
|
||||||
|
- ./glitch:/app/dist/glitch
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
container_name: lysand
|
container_name: lysand
|
||||||
networks:
|
networks:
|
||||||
- lysand-net
|
- 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:
|
db:
|
||||||
image: ghcr.io/lysand-org/postgres:main
|
image: ghcr.io/lysand-org/postgres:main
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,10 @@
|
||||||
# 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.0.30 or later (usage of the latest version is recommended)
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue