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

refactor: 🚚 Use more Versia branding and assets

Browse source
This commit is contained in:
Jesse Wierzbinski 2024-08-24 15:34:49 +02:00 committed by April John
parent 0a1c2b8cb3
commit 9a9dc972b0
11 changed files with 78 additions and 78 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTING.md
View file

@ -28,7 +28,7 @@ curl -fsSL https://bun.sh/install | bash
1. Clone this repository 1. Clone this repository
```bash ```bash
git clone https://github.com/lysand-org/lysand.git git clone https://github.com/lysand-org/server.git
``` ```
2. Install the dependencies 2. Install the dependencies
@ -134,7 +134,7 @@ To add tests for a route, create a `route_file_name.test.ts` file in the same di
### Writing documentation ### Writing documentation
Documentation for the Versia protocol is available on [lysand.org](https://lysand.org/). If you are thinking of modifying the protocol, please make sure to send a pull request over there to get it approved and merged before you send your pull request here. Documentation for the Versia protocol is available on [versia.pub](https://versia.pub/). If you are thinking of modifying the protocol, please make sure to send a pull request over there to get it approved and merged before you send your pull request here.
This project should not need much documentation, but if you think that something needs to be documented, please add it to the README, docs or contribution guide. This project should not need much documentation, but if you think that something needs to be documented, please add it to the README, docs or contribution guide.

2
Dockerfile
View file

@ -36,7 +36,7 @@ COPY --from=build /temp/dist /app/dist
COPY entrypoint.sh /app COPY entrypoint.sh /app
LABEL org.opencontainers.image.authors="Gaspard Wierzbinski (https://cpluspatch.dev)" LABEL org.opencontainers.image.authors="Gaspard Wierzbinski (https://cpluspatch.dev)"
LABEL org.opencontainers.image.source="https://github.com/lysand-org/lysand" LABEL org.opencontainers.image.source="https://github.com/lysand-org/server"
LABEL org.opencontainers.image.vendor="Versia Pub" LABEL org.opencontainers.image.vendor="Versia Pub"
LABEL org.opencontainers.image.licenses="AGPL-3.0-or-later" LABEL org.opencontainers.image.licenses="AGPL-3.0-or-later"
LABEL org.opencontainers.image.title="Versia Server" LABEL org.opencontainers.image.title="Versia Server"

4
README.md
View file

@ -1,12 +1,12 @@
<p align="center"> <p align="center">
<a href="https://lysand.org"><img src="https://cdn.lysand.org/logo-long-dark.webp" alt="Versia Logo" height="110"></a> <a href="https://versia.pub"><img src="https://cdn.versia.pub/branding/versia-dark.webp" alt="Versia Logo" height="110"></a>
</p> </p>
![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge&logo=postgresql&logoColor=white) ![Bun](https://img.shields.io/badge/Bun-%23000000.svg?style=for-the-badge&logo=bun&logoColor=white) ![VS Code Insiders](https://img.shields.io/badge/VS%20Code%20Insiders-35b393.svg?style=for-the-badge&logo=visual-studio-code&logoColor=white) ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white) ![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black) ![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa?style=for-the-badge)](code_of_conduct.md) ![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge&logo=postgresql&logoColor=white) ![Bun](https://img.shields.io/badge/Bun-%23000000.svg?style=for-the-badge&logo=bun&logoColor=white) ![VS Code Insiders](https://img.shields.io/badge/VS%20Code%20Insiders-35b393.svg?style=for-the-badge&logo=visual-studio-code&logoColor=white) ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white) ![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black) ![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa?style=for-the-badge)](code_of_conduct.md)
## What is this? ## What is this?
**Versia Server** (formerly Lysand Server) is a federated social network server based on the [Versia](https://lysand.org) protocol. It is currently in beta phase, with basic federation and almost complete Mastodon API support. **Versia Server** (formerly Lysand Server) is a federated social network server based on the [Versia](https://versia.pub) protocol. It is currently in beta phase, with basic federation and almost complete Mastodon API support.
### Goals ### Goals

2
config/config.example.toml
View file

@ -1,6 +1,6 @@
# This schema always follows the latest dev version of Versia Server, which may not be what you want # This schema always follows the latest dev version of Versia Server, which may not be what you want
# Change the URL to the commit/tag you are using # Change the URL to the commit/tag you are using
#:schema https://raw.githubusercontent.com/lysand-org/lysand/main/config/config.schema.json #:schema https://raw.githubusercontent.com/lysand-org/server/main/config/config.schema.json
[database] [database]
# Main PostgreSQL database connection # Main PostgreSQL database connection

110
docker-compose.yml
View file

@ -1,62 +1,62 @@
services: services:
versia: versia:
image: ghcr.io/lysand-org/lysand:latest image: ghcr.io/lysand-org/server: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 - ./glitch:/app/dist/glitch
restart: unless-stopped restart: unless-stopped
container_name: versia container_name: versia
command: "cli start --all-threads" command: "cli start --all-threads"
networks: networks:
- versia-net - versia-net
depends_on: depends_on:
- db - db
- redis - redis
- sonic - sonic
- fe - fe
fe: fe:
image: ghcr.io/lysand-org/lysand-fe:main image: ghcr.io/lysand-org/frontend:main
container_name: versia-fe container_name: versia-fe
restart: unless-stopped restart: unless-stopped
networks: networks:
- versia-net - versia-net
environment: environment:
NUXT_PUBLIC_API_HOST: https://yourserver.com NUXT_PUBLIC_API_HOST: https://yourserver.com
db: db:
image: ghcr.io/lysand-org/postgres:main image: ghcr.io/lysand-org/postgres:main
container_name: versia-db container_name: versia-db
restart: unless-stopped restart: unless-stopped
environment: environment:
POSTGRES_DB: versia POSTGRES_DB: versia
POSTGRES_USER: versia POSTGRES_USER: versia
POSTGRES_PASSWORD: _______________ POSTGRES_PASSWORD: _______________
networks: networks:
- versia-net - versia-net
volumes: volumes:
- ./db-data:/var/lib/postgresql/data - ./db-data:/var/lib/postgresql/data
redis: redis:
image: redis:alpine image: redis:alpine
container_name: versia-redis container_name: versia-redis
volumes: volumes:
- ./redis-data:/data - ./redis-data:/data
restart: unless-stopped restart: unless-stopped
networks: networks:
- versia-net - versia-net
sonic: sonic:
volumes: volumes:
- ./config.cfg:/etc/sonic.cfg - ./config.cfg:/etc/sonic.cfg
- ./store/:/var/lib/sonic/store/ - ./store/:/var/lib/sonic/store/
image: valeriansaliou/sonic:v1.4.9 image: valeriansaliou/sonic:v1.4.9
container_name: versia-sonic container_name: versia-sonic
restart: unless-stopped restart: unless-stopped
networks: networks:
- versia-net - versia-net
networks: networks:
versia-net: versia-net:

2
docs/glitch-soc.md
View file

@ -2,7 +2,7 @@
Versia Server supports the use of the Glitch-Soc fork of Mastodon's frontend. Here's how to do it: Versia Server supports the use of the Glitch-Soc fork of Mastodon's frontend. Here's how to do it:
1. Download the latest Glitch FE package from [the releases page](https://github.com/lysand-org/lysand/releases) (it should be named `glitch.tar.gz` and be inside the assets of a normal Versia Server release). 1. Download the latest Glitch FE package from [the releases page](https://github.com/lysand-org/server/releases) (it should be named `glitch.tar.gz` and be inside the assets of a normal Versia Server release).
2. Extract the contents of the package into a folder, which you can name `glitch` for simplicity. (if using Docker, now is the time to mount that folder into the container, for example with `-v /path/to/glitch:/app/dist/glitch`) 2. Extract the contents of the package into a folder, which you can name `glitch` for simplicity. (if using Docker, now is the time to mount that folder into the container, for example with `-v /path/to/glitch:/app/dist/glitch`)
3. Change the config to enable Glitch-FE: 3. Change the config to enable Glitch-FE:
```toml ```toml

10
docs/installation.md
View file

@ -20,7 +20,7 @@ Docker is the recommended way to run Versia Server (Podman also works). To run V
1. Download the `docker-compose.yml` file from the repository 1. Download the `docker-compose.yml` file from the repository
> [!NOTE] > [!NOTE]
> You may need to change the image from `ghcr.io/lysand-org/lysand:latest` to `ghcr.io/lysand-org/lysand:main` if you want to use the latest changes from the `main` branch. Make sure to use the config template from the same branch as the server. > You may need to change the image from `ghcr.io/lysand-org/server:latest` to `ghcr.io/lysand-org/server:main` if you want to use the latest changes from the `main` branch. Make sure to use the config template from the same branch as the server.
> [!CAUTION] > [!CAUTION]
> The `latest` tag on the Docker image refers to the latest release (currently `v0.6.0`), not the latest commit on the `main` branch. > The `latest` tag on the Docker image refers to the latest release (currently `v0.6.0`), not the latest commit on the `main` branch.
@ -28,16 +28,16 @@ Docker is the recommended way to run Versia Server (Podman also works). To run V
> **Do not mix configurations from different branches, or everything will break with confusing errors!** > **Do not mix configurations from different branches, or everything will break with confusing errors!**
```bash ```bash
curl -o docker-compose.yml https://raw.githubusercontent.com/lysand-org/lysand/main/docker-compose.yml curl -o docker-compose.yml https://raw.githubusercontent.com/lysand-org/server/main/docker-compose.yml
``` ```
1. Edit the `docker-compose.yml` file to set up the database connection and other settings 1. Edit the `docker-compose.yml` file to set up the database connection and other settings
2. Download the `config.example.toml` file from the repository 2. Download the `config.example.toml` file from the repository
```bash ```bash
# From main branch # From main branch
curl -o config.example.toml https://raw.githubusercontent.com/lysand-org/lysand/main/config/config.example.toml curl -o config.example.toml https://raw.githubusercontent.com/lysand-org/server/main/config/config.example.toml
# For a specific release (e.g. v0.6.0) # For a specific release (e.g. v0.6.0)
curl -o config.example.toml https://raw.githubusercontent.com/lysand-org/lysand/v0.6.0/config/config.example.toml curl -o config.example.toml https://raw.githubusercontent.com/lysand-org/server/v0.6.0/config/config.example.toml
``` ```
4. Edit the `config.example.toml` file to set up the database connection and other settings, rename it to `config.toml`, then place it inside `config/` (create the `config/` directory if it does not exist) 4. Edit the `config.example.toml` file to set up the database connection and other settings, rename it to `config.toml`, then place it inside `config/` (create the `config/` directory if it does not exist)
5. Run the following command to start the server: 5. Run the following command to start the server:
@ -58,7 +58,7 @@ To check server logs, run `docker compose logs lysand`. The server will likely s
1. Clone this repository 1. Clone this repository
```bash ```bash
git clone https://github.com/lysand-org/lysand.git git clone https://github.com/lysand-org/server.git
``` ```
2. Install the dependencies 2. Install the dependencies

6
package.json
View file

@ -10,9 +10,9 @@
"url": "https://cpluspatch.com" "url": "https://cpluspatch.com"
}, },
"bugs": { "bugs": {
"url": "https://github.com/lysand-org/lysand/issues" "url": "https://github.com/lysand-org/server/issues"
}, },
"icon": "https://github.com/lysand-org/lysand", "icon": "https://github.com/lysand-org/server",
"license": "AGPL-3.0-or-later", "license": "AGPL-3.0-or-later",
"keywords": ["federated", "activitypub", "bun"], "keywords": ["federated", "activitypub", "bun"],
"workspaces": ["packages/*"], "workspaces": ["packages/*"],
@ -25,7 +25,7 @@
], ],
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://github.com/lysand-org/lysand.git" "url": "git+https://github.com/lysand-org/server.git"
}, },
"private": true, "private": true,
"scripts": { "scripts": {

4
packages/glitch-server/main.ts
View file

@ -253,10 +253,10 @@ const htmlTransforms = async (
mascot: "https://media.tech.lgbt/site_uploads/files/000/000/004/original/1a16a73feb5c2463.png", mascot: "https://media.tech.lgbt/site_uploads/files/000/000/004/original/1a16a73feb5c2463.png",
profile_directory: true, profile_directory: true,
registrations_open: true, registrations_open: true,
repository: "lysand-org/lysand", repository: "lysand-org/server",
search_enabled: true, search_enabled: true,
single_user_mode: false, single_user_mode: false,
source_url: "https://github.com/lysand-org/lysand", source_url: "https://github.com/lysand-org/server",
sso_redirect: null, sso_redirect: null,
status_page_url: null, status_page_url: null,
streaming_api_base_url: `wss://${ streaming_api_base_url: `wss://${

6
packages/plugin-kit/package.json
View file

@ -10,9 +10,9 @@
"url": "https://cpluspatch.com" "url": "https://cpluspatch.com"
}, },
"bugs": { "bugs": {
"url": "https://github.com/lysand-org/lysand/issues" "url": "https://github.com/lysand-org/server/issues"
}, },
"icon": "https://github.com/lysand-org/lysand", "icon": "https://github.com/lysand-org/server",
"license": "AGPL-3.0-or-later", "license": "AGPL-3.0-or-later",
"keywords": ["federated", "activitypub", "bun"], "keywords": ["federated", "activitypub", "bun"],
"maintainers": [ "maintainers": [
@ -24,7 +24,7 @@
], ],
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://github.com/lysand-org/lysand.git" "url": "git+https://github.com/lysand-org/server.git"
}, },
"private": true, "private": true,
"dependencies": { "dependencies": {

2
server/api/api/v2/instance/index.ts
View file

@ -39,7 +39,7 @@ export default apiRoute((app) =>
version: "4.3.0-alpha.3+glitch", version: "4.3.0-alpha.3+glitch",
// @ts-expect-error Temporary until package also gets the rebranding // @ts-expect-error Temporary until package also gets the rebranding
versia_version: version, versia_version: version,
source_url: "https://github.com/lysand-org/lysand", source_url: "https://github.com/lysand-org/server",
description: config.instance.description, description: config.instance.description,
usage: { usage: {
users: { users: {