Add quick start, change defaults.

This commit is contained in:
Paul
2021-06-15 16:10:32 +01:00
parent e714b36500
commit 4f967cbd9d
3 changed files with 25 additions and 4 deletions

View File

@@ -22,7 +22,7 @@ JANUARY_PUBLIC_URL=http://local.revolt.chat:7000
## ##
# If you are sure that you don't want to use hCaptcha, set to 1. # If you are sure that you don't want to use hCaptcha, set to 1.
REVOLT_UNSAFE_NO_CAPTCHA=0 REVOLT_UNSAFE_NO_CAPTCHA=1
# hCaptcha API key # hCaptcha API key
# REVOLT_HCAPTCHA_KEY=0x0000000000000000000000000000000000000000 # REVOLT_HCAPTCHA_KEY=0x0000000000000000000000000000000000000000
@@ -36,7 +36,7 @@ REVOLT_UNSAFE_NO_CAPTCHA=0
## ##
# If you are sure that you don't want to use email verification, set to 1. # If you are sure that you don't want to use email verification, set to 1.
REVOLT_UNSAFE_NO_EMAIL=0 REVOLT_UNSAFE_NO_EMAIL=1
# SMTP host # SMTP host
# REVOLT_SMTP_HOST=smtp.example.com # REVOLT_SMTP_HOST=smtp.example.com
@@ -63,8 +63,9 @@ REVOLT_MAX_GROUP_SIZE=150
# VAPID keys for push notifications # VAPID keys for push notifications
# Generate using this guide: https://gitlab.insrt.uk/revolt/delta/-/wikis/vapid # Generate using this guide: https://gitlab.insrt.uk/revolt/delta/-/wikis/vapid
REVOLT_VAPID_PRIVATE_KEY=<replace_me> # --> Please replace these keys before going into production! <--
REVOLT_VAPID_PUBLIC_KEY=<replace_me> REVOLT_VAPID_PRIVATE_KEY=LS0tLS1CRUdJTiBFQyBQUklWQVRFIEtFWS0tLS0tCk1IY0NBUUVFSUJSUWpyTWxLRnBiVWhsUHpUbERvcEliYk1yeVNrNXpKYzVYVzIxSjJDS3hvQW9HQ0NxR1NNNDkKQXdFSG9VUURRZ0FFWnkrQkg2TGJQZ2hEa3pEempXOG0rUXVPM3pCajRXT1phdkR6ZU00c0pqbmFwd1psTFE0WAp1ZDh2TzVodU94QWhMQlU3WWRldVovWHlBdFpWZmNyQi9BPT0KLS0tLS1FTkQgRUMgUFJJVkFURSBLRVktLS0tLQo=
REVOLT_VAPID_PUBLIC_KEY=BGcvgR-i2z4IQ5Mw841vJvkLjt8wY-FjmWrw83jOLCY52qcGZS0OF7nfLzuYbjsQISwVO2HXrmf18gLWVX3Kwfw=
## ##

View File

@@ -1,5 +1,18 @@
This is still a work-in-progress and some things may not work, notably Autumn does not auto-create S3 buckets yet and the app points to api.revolt.chat by default. This is still a work-in-progress and some things may not work, notably Autumn does not auto-create S3 buckets yet and the app points to api.revolt.chat by default.
## 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://gitlab.insrt.uk/revolt/self-hosted revolt
cd revolt
cp .env.example .env
docker-compose up -d
```
## Usage ## Usage
Copy the `.env` file and edit according to your needs. Copy the `.env` file and edit according to your needs.
@@ -13,3 +26,9 @@ Then bring up REVOLT:
```bash ```bash
docker-compose up -d docker-compose up -d
``` ```
## To-Do
- Interactive setup.
- Add Caddy.
- Add voso.

View File

@@ -22,6 +22,7 @@ services:
# REVOLT Web App # REVOLT Web App
web: web:
image: revoltchat/client image: revoltchat/client
env_file: .env
ports: ports:
- "5000:5000" - "5000:5000"
restart: always restart: always