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

Merge pull request 'docs: focus on local install, ".env" before "make setup"' (#31) from readme-revamp into master

Browse Source 
Reviewed-on: varia/octomode#31
This commit is contained in:
decentral1se 2023-11-24 15:36:46 +01:00
commit 9a96c2a01d
1 changed files with 34 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
README.md
View File

@ -6,37 +6,29 @@ Octomode is a collective editing space for PDF making, using Etherpad, Paged.js
Inspired by the multi-centered, tentacular cognition capabilities of the octopus, we imagined a space in which the artificial boundaries of writing and design can be crossed; where writing, editing and designing can be done in one environment simultaneously, allowing the format to influence the matter and vice-versa. Inspired by the multi-centered, tentacular cognition capabilities of the octopus, we imagined a space in which the artificial boundaries of writing and design can be crossed; where writing, editing and designing can be done in one environment simultaneously, allowing the format to influence the matter and vice-versa.
More expanded documentation can be found here: <https://cc.vvvvvvaria.org/wiki/Octomode> More expanded documentation can be found [here](https://cc.vvvvvvaria.org/wiki/Octomode).
An installation guide can be found below. ## Local install
## Install octomode > **WARNING**: It's recommended to use Firefox when working with Octomode
> locally. Chrome or Chromium do not load external etherpads in iframes.
### Prerequisites
* Existing [Etherpad](https://etherpad.org) installation
* [Pandoc](https://pandoc.org/) >= 2.x
* Python >= 3.11.x
### Get started
You can clone this repository to run octomode on your own computer or server. You can clone this repository to run octomode on your own computer or server.
`git clone https://git.vvvvvvaria.org/varia/octomode.git` ```
git clone https://git.vvvvvvaria.org/varia/octomode.git
cd octomode
```
Install the dependencies. Configure your environment, save the following configuration settings as to a file called `.env`.
All the `python` dependencies are listed in `requirements.txt`
To install them, you can run:
`make setup`
This creates a virtual environment at `.venv/` and installs all the dependencies here.
Next to this, you also need to install `pandoc`.
`sudo apt install pandoc`
Now we need to configure *octomode*:
`cd octomode`
`nano .env`
Configure your environment, save the following configuration settings as to a file called `.env`:
``` ```
OCTOMODE_APPLICATION_ROOT=XXX OCTOMODE_APPLICATION_ROOT=XXX
@ -46,35 +38,34 @@ OCTOMODE_PAD_API_URL=XXX
OCTOMODE_PAD_API_KEY=XXX OCTOMODE_PAD_API_KEY=XXX
``` ```
- **OCTOMODE_PAD_API_KEY**: *required*, **no default**
- **OCTOMODE_APPLICATION_ROOT**: *optional*, default: `/` - **OCTOMODE_APPLICATION_ROOT**: *optional*, default: `/`
- **OCTOMODE_PORTNUMBER**: *optional*, default: `5001` - **OCTOMODE_PORTNUMBER**: *optional*, default: `5001`
- **OCTOMODE_PAD_URL**: *optional*, default: `https://pad.vvvvvvaria.org/` - **OCTOMODE_PAD_URL**: *optional*, default: `https://pad.vvvvvvaria.org/`
- **OCTOMODE_PAD_API_URL**: *optional*, default: `https://pad.vvvvvvaria.org/api/1.2.15/` - **OCTOMODE_PAD_API_URL**: *optional*, default: `https://pad.vvvvvvaria.org/api/1.2.15/`
- **OCTOMODE_PAD_API_KEY**: *required*, **no default**
(Note: You must provide a value for `OCTOMODE_PAD_API_KEY`.) **Note**: you must provide a value for `OCTOMODE_PAD_API_KEY`.
`make run` (runs the Flask application) Now we install the dependencies. All the `python` dependencies are listed in `requirements.txt`. To install them, you can run.
Open the application at port `5001`, for example: <http://localhost:5001> or <https://mydomainname.ext:5001>. ```
make setup
```
## Install octomode with an URL prefix This creates a virtual environment at `.venv` and installs all the dependencies here. Next, we also need to install `pandoc`.
If you want to install octomode with an URL prefix, like <https://mydomainname.ext/octomode/>, then you can use the gunicorn WSGI. ```
sudo apt install pandoc
```
If you have ran the `make setup` command already, then `gunicorn` is already installed. And finally, run the application.
Configure your application root URL in your `.env` file. ```
make run
```
You can simply run *octomode* now with the following command to run it with `gunicorn` (and not the built-in Flask dev server): Open the application at port `5001`, for example: http://localhost:5001
`make action` ## Install with URL prefix
### Dependencies If you want to install octomode with an URL prefix, like <https://mydomainname.ext/octomode/>, then you can use the gunicorn WSGI. If you have ran the `make setup` command already, then `gunicorn` is already installed. Configure your application root URL in your `.env` file. You can simply run *octomode* now with the following command to run it with `gunicorn` (and not the built-in Flask dev server): `make action`
* pandoc
* python dependencies, see: `requirements.txt`
## Use octomode locally
It's recommended to use Firefox when working with octomode locally. Chrome or Chromium do not load external etherpads in iframes.