hippoz/waffle
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

add hosting guide (dockerless hosting guide coming soon)

Browse source
This commit is contained in:
hippoz 2022-04-28 04:26:01 +03:00
parent 7bf211a7e2
commit 686aba5541
Signed by: hippoz
GPG key ID: 7C52899193467641
1 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -1,2 +1,17 @@
# waffle.chat
# waffle
Waffle is a simple, focused chat application and protocol meant to be self-hosted.
# Hosting
## Docker
If you plan on self-hosting Waffle, it's recommended to use Docker and docker-compose like shown below. This isn't recommended if you plan on developing Waffle. The guide below assumes you have `git` installed on your system (on Debian/Ubuntu: `sudo apt install git`):
1. [Install Docker using the official guide](https://docs.docker.com/engine/install/)
2. [Install docker-compose using the official guide](https://docs.docker.com/compose/install/)
3. Clone the Waffle repository: `git clone https://git.hippoz.xyz/hippoz/waffle`
4. Enter the repository's directory: `cd waffle`
5. **Optionally,** you can open up `docker-compose.yml` in your text editor to change options like the port. The default port is `5002`.
6. Start the stack: `docker-compose up -d`
7. All done! 🎉 Waffle is now running on port `5002`.