diff --git a/.env.example b/.env.example index e2f8cb6..3c014c9 100644 --- a/.env.example +++ b/.env.example @@ -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. -REVOLT_UNSAFE_NO_CAPTCHA=0 +REVOLT_UNSAFE_NO_CAPTCHA=1 # hCaptcha API key # 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. -REVOLT_UNSAFE_NO_EMAIL=0 +REVOLT_UNSAFE_NO_EMAIL=1 # SMTP host # REVOLT_SMTP_HOST=smtp.example.com @@ -63,8 +63,9 @@ REVOLT_MAX_GROUP_SIZE=150 # VAPID keys for push notifications # Generate using this guide: https://gitlab.insrt.uk/revolt/delta/-/wikis/vapid -REVOLT_VAPID_PRIVATE_KEY= -REVOLT_VAPID_PUBLIC_KEY= +# --> Please replace these keys before going into production! <-- +REVOLT_VAPID_PRIVATE_KEY=LS0tLS1CRUdJTiBFQyBQUklWQVRFIEtFWS0tLS0tCk1IY0NBUUVFSUJSUWpyTWxLRnBiVWhsUHpUbERvcEliYk1yeVNrNXpKYzVYVzIxSjJDS3hvQW9HQ0NxR1NNNDkKQXdFSG9VUURRZ0FFWnkrQkg2TGJQZ2hEa3pEempXOG0rUXVPM3pCajRXT1phdkR6ZU00c0pqbmFwd1psTFE0WAp1ZDh2TzVodU94QWhMQlU3WWRldVovWHlBdFpWZmNyQi9BPT0KLS0tLS1FTkQgRUMgUFJJVkFURSBLRVktLS0tLQo= +REVOLT_VAPID_PUBLIC_KEY=BGcvgR-i2z4IQ5Mw841vJvkLjt8wY-FjmWrw83jOLCY52qcGZS0OF7nfLzuYbjsQISwVO2HXrmf18gLWVX3Kwfw= ## diff --git a/README.md b/README.md index 9a988d2..c9cd307 100644 --- a/README.md +++ b/README.md @@ -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. +## 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 Copy the `.env` file and edit according to your needs. @@ -13,3 +26,9 @@ Then bring up REVOLT: ```bash docker-compose up -d ``` + +## To-Do + +- Interactive setup. +- Add Caddy. +- Add voso. diff --git a/docker-compose.yml b/docker-compose.yml index cb67911..0d28449 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -22,6 +22,7 @@ services: # REVOLT Web App web: image: revoltchat/client + env_file: .env ports: - "5000:5000" restart: always