From 832f72160f574f86c8a8897e5dcb3d6382d8192c Mon Sep 17 00:00:00 2001 From: Jesse Wierzbinski Date: Sat, 24 Aug 2024 15:34:49 +0200 Subject: [PATCH] refactor: :truck: Use more Versia branding and assets --- CONTRIBUTING.md | 4 +- Dockerfile | 2 +- README.md | 4 +- config/config.example.toml | 2 +- docker-compose.yml | 114 ++++++++++++++-------------- docs/glitch-soc.md | 2 +- docs/installation.md | 10 +-- package.json | 6 +- packages/glitch-server/main.ts | 4 +- packages/plugin-kit/package.json | 6 +- server/api/api/v2/instance/index.ts | 2 +- 11 files changed, 78 insertions(+), 78 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 15b4afcc..bfcdfb22 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,7 +28,7 @@ curl -fsSL https://bun.sh/install | bash 1. Clone this repository ```bash -git clone https://github.com/lysand-org/lysand.git +git clone https://github.com/lysand-org/server.git ``` 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 -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. diff --git a/Dockerfile b/Dockerfile index 63f6619d..ee529257 100644 --- a/Dockerfile +++ b/Dockerfile @@ -36,7 +36,7 @@ COPY --from=build /temp/dist /app/dist COPY entrypoint.sh /app 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.licenses="AGPL-3.0-or-later" LABEL org.opencontainers.image.title="Versia Server" diff --git a/README.md b/README.md index 161b61c7..69db1e5f 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@

- Versia Logo + Versia Logo

![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? -**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 diff --git a/config/config.example.toml b/config/config.example.toml index 910752bd..71594784 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -1,6 +1,6 @@ # 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 -#: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] # Main PostgreSQL database connection diff --git a/docker-compose.yml b/docker-compose.yml index de629888..4ecec0bb 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,62 +1,62 @@ services: - versia: - image: ghcr.io/lysand-org/lysand:latest - volumes: - - ./logs:/app/dist/logs - - ./config:/app/dist/config - - ./uploads:/app/dist/uploads - - ./glitch:/app/dist/glitch - restart: unless-stopped - container_name: versia - command: "cli start --all-threads" - networks: - - versia-net - depends_on: - - db - - redis - - sonic - - fe - - fe: - image: ghcr.io/lysand-org/lysand-fe:main - container_name: versia-fe - restart: unless-stopped - networks: - - versia-net - environment: - NUXT_PUBLIC_API_HOST: https://yourserver.com - - db: - image: ghcr.io/lysand-org/postgres:main - container_name: versia-db - restart: unless-stopped - environment: - POSTGRES_DB: versia - POSTGRES_USER: versia - POSTGRES_PASSWORD: _______________ - networks: - - versia-net - volumes: - - ./db-data:/var/lib/postgresql/data + versia: + image: ghcr.io/lysand-org/server:latest + volumes: + - ./logs:/app/dist/logs + - ./config:/app/dist/config + - ./uploads:/app/dist/uploads + - ./glitch:/app/dist/glitch + restart: unless-stopped + container_name: versia + command: "cli start --all-threads" + networks: + - versia-net + depends_on: + - db + - redis + - sonic + - fe - redis: - image: redis:alpine - container_name: versia-redis - volumes: - - ./redis-data:/data - restart: unless-stopped - networks: - - versia-net + fe: + image: ghcr.io/lysand-org/frontend:main + container_name: versia-fe + restart: unless-stopped + networks: + - versia-net + environment: + NUXT_PUBLIC_API_HOST: https://yourserver.com - sonic: - volumes: - - ./config.cfg:/etc/sonic.cfg - - ./store/:/var/lib/sonic/store/ - image: valeriansaliou/sonic:v1.4.9 - container_name: versia-sonic - restart: unless-stopped - networks: - - versia-net + db: + image: ghcr.io/lysand-org/postgres:main + container_name: versia-db + restart: unless-stopped + environment: + POSTGRES_DB: versia + POSTGRES_USER: versia + POSTGRES_PASSWORD: _______________ + networks: + - versia-net + volumes: + - ./db-data:/var/lib/postgresql/data + + redis: + image: redis:alpine + container_name: versia-redis + volumes: + - ./redis-data:/data + restart: unless-stopped + networks: + - versia-net + + sonic: + volumes: + - ./config.cfg:/etc/sonic.cfg + - ./store/:/var/lib/sonic/store/ + image: valeriansaliou/sonic:v1.4.9 + container_name: versia-sonic + restart: unless-stopped + networks: + - versia-net networks: - versia-net: \ No newline at end of file + versia-net: diff --git a/docs/glitch-soc.md b/docs/glitch-soc.md index 06ec2135..0b0eeb7f 100644 --- a/docs/glitch-soc.md +++ b/docs/glitch-soc.md @@ -2,7 +2,7 @@ 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`) 3. Change the config to enable Glitch-FE: ```toml diff --git a/docs/installation.md b/docs/installation.md index 5211c0d6..b700519d 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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 > [!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] > 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!** ```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 2. Download the `config.example.toml` file from the repository ```bash # 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) -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) 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 ```bash -git clone https://github.com/lysand-org/lysand.git +git clone https://github.com/lysand-org/server.git ``` 2. Install the dependencies diff --git a/package.json b/package.json index 16a14ed0..69689806 100644 --- a/package.json +++ b/package.json @@ -10,9 +10,9 @@ "url": "https://cpluspatch.com" }, "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", "keywords": ["federated", "activitypub", "bun"], "workspaces": ["packages/*"], @@ -25,7 +25,7 @@ ], "repository": { "type": "git", - "url": "git+https://github.com/lysand-org/lysand.git" + "url": "git+https://github.com/lysand-org/server.git" }, "private": true, "scripts": { diff --git a/packages/glitch-server/main.ts b/packages/glitch-server/main.ts index 9742ca4b..5eeef968 100644 --- a/packages/glitch-server/main.ts +++ b/packages/glitch-server/main.ts @@ -253,10 +253,10 @@ const htmlTransforms = async ( mascot: "https://media.tech.lgbt/site_uploads/files/000/000/004/original/1a16a73feb5c2463.png", profile_directory: true, registrations_open: true, - repository: "lysand-org/lysand", + repository: "lysand-org/server", search_enabled: true, single_user_mode: false, - source_url: "https://github.com/lysand-org/lysand", + source_url: "https://github.com/lysand-org/server", sso_redirect: null, status_page_url: null, streaming_api_base_url: `wss://${ diff --git a/packages/plugin-kit/package.json b/packages/plugin-kit/package.json index 52948db6..8d78a7e7 100644 --- a/packages/plugin-kit/package.json +++ b/packages/plugin-kit/package.json @@ -10,9 +10,9 @@ "url": "https://cpluspatch.com" }, "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", "keywords": ["federated", "activitypub", "bun"], "maintainers": [ @@ -24,7 +24,7 @@ ], "repository": { "type": "git", - "url": "git+https://github.com/lysand-org/lysand.git" + "url": "git+https://github.com/lysand-org/server.git" }, "private": true, "dependencies": { diff --git a/server/api/api/v2/instance/index.ts b/server/api/api/v2/instance/index.ts index 9d515c3d..2684f2a0 100644 --- a/server/api/api/v2/instance/index.ts +++ b/server/api/api/v2/instance/index.ts @@ -39,7 +39,7 @@ export default apiRoute((app) => version: "4.3.0-alpha.3+glitch", // @ts-expect-error Temporary until package also gets the rebranding versia_version: version, - source_url: "https://github.com/lysand-org/lysand", + source_url: "https://github.com/lysand-org/server", description: config.instance.description, usage: { users: {