murm/mrmBot-Matrix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Mention Docker in setup docs

Browse source
This commit is contained in:
Essem 2022-09-28 19:55:47 -05:00
parent 6b1b2e1c5e
commit 638b5512f1
No known key found for this signature in database
GPG key ID: 7D497397CC3A2A8C
2 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/docker.md
View file

@ -1,6 +1,7 @@
# Docker
You can run the bot as well as its dependencies as a series of Docker containers. However, the manual setup is still recommended if you want more control over the bot.
To start, install Docker on your system via the instructions here: https://docs.docker.com/engine/install/#server
[To start, install Docker on your system via the instructions here.](https://docs.docker.com/engine/install/#server)
Once you've installed Docker, you should clone the esmBot repo:
```sh

7
docs/setup.md
View file

@ -12,6 +12,9 @@ Here are some instructions to get esmBot up and running from source.
If you have any further questions regarding setup, feel free to ask in the #self-hosting-support channel on the [esmBot Support server](https://projectlounge.pw/support).
!!! tip
You can run the bot using Docker for a somewhat simpler setup experience. [Click here to go to the Docker setup guide.](https://esmbot.github.io/esmBot/docker)
### 1. Install the required native dependencies.
Choose the distro you're using below for insallation instructions.
=== "Debian/Ubuntu"
@ -107,7 +110,7 @@ esmBot officially supports two database systems: SQLite and PostgreSQL. While SQ
If you would like to use the SQLite database, no configuration is needed and you can move on to the next step.
If you would like to use the PostgreSQL database, view the setup instructions [here](https://github.com/esmBot/esmBot/wiki/PostgreSQL) and come back here when you're finished.
If you would like to use the PostgreSQL database, view the setup instructions [here](https://esmbot.github.io/esmBot/postgresql) and come back here when you're finished.
***
@ -166,7 +169,7 @@ This will launch a text editor with the file ready to go. Create a Discord appli
When you're finished editing the file, press Ctrl + X, then Y and Enter.
An overview of each of the variables in the `.env` file can be found [here](https://github.com/esmBot/esmBot/wiki/Config).
An overview of each of the variables in the `.env` file can be found [here](https://esmbot.github.io/esmBot/config).
***