CC/octomode
12
0
Fork 0
Code Issues 18 Pull Requests Projects Releases Wiki Activity

Update 'README.md'

Browse Source
This commit is contained in:
mb 2022-01-12 21:30:30 +01:00
parent 723624aa43
commit 58c48c93af
1 changed files with 5 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -4,21 +4,16 @@
Octomode is a collective editing space for PDF making, using Etherpad, Paged.js and Flask. Octomode is a collective editing space for PDF making, using Etherpad, Paged.js and Flask.
## Install octomode ## Install octomode locally
`git clone https://git.vvvvvvaria.org/mb/octomode.git` `make setup` (sets up a virtual environment and install the requirements)
`cd octomode` `make run` (runs the Flask application)
`python3 -m venv .venv` Open the application at `http://localhost:5001`.
`source .venv/bin/activate` ## Install octomode on a server
`pip install -r requirements.txt`
Then:
* init etherpump (`etherpump init`)
* configure the webserver to listen to the port of the flask application, for example with a subdomain * configure the webserver to listen to the port of the flask application, for example with a subdomain
* expand the current https certificate for this subdomain * expand the current https certificate for this subdomain
* restart nginx (`sudo service reload nginx`) * restart nginx (`sudo service reload nginx`)