From 9b827125f7f5a6947ded6ee87ea2afe2b0efa1f8 Mon Sep 17 00:00:00 2001 From: josiah Date: Sat, 14 Aug 2021 15:58:48 -0500 Subject: [PATCH] Remove unnecessary text from setup.md. --- SETUP.md | 117 ------------------------------------------------------- 1 file changed, 117 deletions(-) diff --git a/SETUP.md b/SETUP.md index d34f380..78b3fd7 100644 --- a/SETUP.md +++ b/SETUP.md @@ -1,13 +1,5 @@ # Setup - -nio-template is a sample repository of a working Matrix bot that can be taken -and transformed into one's own bot, service or whatever else may be necessary. -Below is a quick setup guide to running the existing bot. - ## Install the dependencies - -There are two paths to installing the dependencies for development. - ### Using `docker-compose` It is **recommended** to use Docker Compose to run the bot while @@ -34,60 +26,6 @@ is controlled by `bind_addresses` in the `listeners` section of Synapse's config. If present, either add the docker internal IP address to the list, or remove the option altogether to allow all addresses. -### Running natively - -If you would rather not or are unable to run docker, the following will -instruct you on how to install the dependencies natively: - -#### Install libolm - -You can install [libolm](https://gitlab.matrix.org/matrix-org/olm) from source, -or alternatively, check your system's package manager. Version `3.0.0` or -greater is required. - -**(Optional) postgres development headers** - -By default, the bot uses SQLite as its storage backend. This is fine for a few -hundred users, but if you plan to support a much higher volume of requests, you -may consider using Postgres as a database backend instead. - -If you want to use postgres as a database backend, you'll need to install -postgres development headers: - -Debian/Ubuntu: - -``` -sudo apt install libpq-dev libpq5 -``` - -Arch: - -``` -sudo pacman -S postgresql-libs -``` - -#### Install Python dependencies - -Create and activate a Python 3 virtual environment: - -``` -virtualenv -p python3 env -source env/bin/activate -``` - -Install python dependencies: - -``` -pip install -e . -``` - -(Optional) If you want to use postgres as a database backend, use the following -command to install postgres dependencies alongside those that are necessary: - -``` -pip install -e ".[postgres]" -``` - ## Configuration Copy the sample configuration file to a new `config.yaml` file. @@ -98,55 +36,6 @@ cp sample.config.yaml config.yaml Edit the config file. The `matrix` section must be modified at least. -#### (Optional) Set up a Postgres database - -Create a postgres user and database for matrix-reminder-bot: - -``` -sudo -u postgresql psql createuser nio-template -W # prompts for a password -sudo -u postgresql psql createdb -O nio-template nio-template -``` - -Edit the `storage.database` config option, replacing the `sqlite://...` string with `postgres://...`. The syntax is: - -``` -database: "postgres://username:password@localhost/dbname?sslmode=disable" -``` - -See also the comments in `sample.config.yaml`. - -## Running - -### Docker - -Refer to the docker [run instructions](docker/README.md#running). - -### Native installation - -Make sure to source your python environment if you haven't already: - -``` -source env/bin/activate -``` - -Then simply run the bot with: - -``` -molly -``` - -You'll notice that "molly" is scattered throughout the codebase. When -it comes time to modifying the code for your own purposes, you are expected to -replace every instance of "molly" and its variances with your own -project's name. - -By default, the bot will run with the config file at `./config.yaml`. However, an -alternative relative or absolute filepath can be specified after the command: - -``` -molly other-config.yaml -``` - ## Testing the bot works Invite the bot to a room and it should accept the invite and join. @@ -165,9 +54,3 @@ The message should be repeated back to you by the bot. Congratulations! Your bot is up and running. Now you can modify the code, re-run the bot and see how it behaves. Have fun! - -## Troubleshooting - -If you had any difficulties with this setup process, please [file an -issue](https://github.com/anoadragon453/nio-template/issues]) or come talk -about it in [the matrix room](https://matrix.to/#/#nio-template).