You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
70 lines
1.9 KiB
Markdown
70 lines
1.9 KiB
Markdown
This is still a work-in-progress and some things may not work but for the most part everything has been tested without issue!
|
|
|
|
**Note**: the Revolt team is primarily focused on other components of the app, don't expect any immediate support, some issues may also be seen as out of scope for what this repo is trying to achieve so they may be marked as WONTFIX.
|
|
|
|
## Errata Notice
|
|
|
|
The CI for the API server (revoltchat/server) is currently being reworked, I was having a few issues with building both amd64/arm64.
|
|
|
|
Please make sure you're using the correct image for your platform:
|
|
- amd64: `revoltchat/server:master`
|
|
- arm64: `revoltchat/server:0.5.3-alpha.8`
|
|
|
|
Related issue: https://github.com/revoltchat/delta/issues/116
|
|
|
|
## Quick Start
|
|
|
|
This repository provides reasonable defaults, so you can immediately get started with it on your local machine.
|
|
|
|
> ⚠️ Not recommended for production, see below for full guide.
|
|
|
|
```bash
|
|
git clone https://github.com/revoltchat/self-hosted revolt
|
|
cd revolt
|
|
cp .env.example .env
|
|
docker-compose up -d
|
|
```
|
|
|
|
Then simply go to http://local.revolt.chat:5000
|
|
|
|
## Setup
|
|
|
|
Clone this repository.
|
|
|
|
```bash
|
|
git clone https://github.com/revoltchat/self-hosted revolt
|
|
cd revolt
|
|
```
|
|
|
|
Copy the `.env` file and edit according to your needs.
|
|
|
|
> ⚠️ The default configuration is intended for testing and only works on your local machine. If you want to deploy to a remote server, you need to edit the URLs in the `.env` file. \
|
|
> If you get a network error when trying to log in, **double check your configuration before opening an issue.**
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
Then bring up Revolt:
|
|
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
## Expose Database
|
|
|
|
You can insecurely expose the database by creating `docker-compose.override.yml` with the content:
|
|
|
|
```yml
|
|
services:
|
|
database:
|
|
ports:
|
|
- "27017:27017"
|
|
```
|
|
|
|
## To-Do
|
|
|
|
- Interactive setup.
|
|
- Add Caddy.
|
|
- Add voso.
|