Browse Source

refactor: override config from env

Closes varia/octomode#8
pull/30/head
decentral1se 2 years ago
parent
commit
d9800c5223
No known key found for this signature in database GPG Key ID: 3789458B3D0C410
  1. 15
      README.md
  2. 6
      config.py
  3. 14
      octomode.py

15
README.md

@ -83,6 +83,21 @@ You can clone this repository to run octomode on your own computer or server.
`make setup` (sets up a virtual environment and install the requirements, you only need to do this once) `make setup` (sets up a virtual environment and install the requirements, you only need to do this once)
Then you can configure your environment:
- **OCTOMODE_PORTNUMBER**: optional, default: `5001`
- **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_KEY**: required, **no default**
You must provide a value for `OCTOMODE_PAD_API_KEY`.
You can do this by passing the values on the command-line before running octomode:
```
export OCTOMODE_PAD_API_KEY=...
```
`make run` (runs the Flask application) `make run` (runs the Flask application)
Open the application at <http://localhost:5001>. Open the application at <http://localhost:5001>.

6
config.py

@ -1,6 +0,0 @@
class Config(object):
APPLICATION_ROOT = '/'
PORTNUMBER = 5001
PAD_URL = 'https://pad.vvvvvvaria.org/' # with a slash in the end!
PAD_API_URL = 'https://pad.vvvvvvaria.org/api/1.2.15/'
PAD_API_KEY = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

14
octomode.py

@ -14,8 +14,20 @@ import pypandoc
# To read the Markdown metadat # To read the Markdown metadat
import markdown import markdown
class Config(object):
APPLICATION_ROOT = '/'
PORTNUMBER = int(os.environ.get('OCTOMODE_PORTNUMBER', 5001))
PAD_URL = os.environ.get('OCTOMODE_PAD_URL', 'https://pad.vvvvvvaria.org/' )
PAD_API_URL = os.environ.get('OCTOMODE_PAD_API_URL', 'https://pad.vvvvvvaria.org/api/1.2.15/')
PAD_API_KEY = os.environ.get('OCTOMODE_PAD_API_KEY', '')
APP = Flask(__name__) APP = Flask(__name__)
APP.config.from_object("config.Config") APP.config.from_object(Config)
if APP.config.get('PAD_API_KEY', '') == '':
print("error: you must provide a value for OCTOMODE_PAD_API_KEY")
print("error: e.g. export OCTOMODE_PAD_API_KEY=...")
exit(1)
# --- # ---

Loading…
Cancel
Save