add first try of installation instructions
This commit is contained in:
parent
e4dbef8368
commit
a71132d8a5
3 changed files with 32 additions and 1 deletions
15
README.md
15
README.md
|
@ -1 +1,16 @@
|
|||
# lare's autopeering implementation
|
||||
|
||||
This is my (LARE-MNT) implementation of an auto peering system
|
||||
|
||||
It consists of two parts:
|
||||
1. the "server"
|
||||
- handling user auth (via kioubit)
|
||||
- add/edit/delete peerings (#todo)
|
||||
- communicate new/update peerings with nodes #todo
|
||||
2. the "nodes daemon" #todo
|
||||
- reveives new/updated peering configs from the "server" #todo
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
see [installation.md](installation.md)
|
16
installation.md
Normal file
16
installation.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
# Installation
|
||||
|
||||
## Server
|
||||
|
||||
1. clone repository to the main server
|
||||
2. change into `web`
|
||||
3. create VirtualEnv: run `python3 -m venv venv` then `source venv/bin/activate`
|
||||
4. install dependencies: `pip install -r requirement.txt`
|
||||
5. create config file:
|
||||
1. `cp backend/config.example.json config.json`
|
||||
2. edit example config to represent your situation
|
||||
3. remove comments in config file
|
||||
6. run the server: `python backend/main.py`
|
||||
|
||||
## Nodes
|
||||
#todo
|
|
@ -21,7 +21,7 @@
|
|||
"port": 8042,
|
||||
"domain": "example.org", // domain to use for kioubit verification service
|
||||
"base-dir": "/", //optional:directury for which it is reachable (if behind some sort of reverse proxy) default "/"
|
||||
"peerings-dir": "/path/to/peering-configs/", // optional; default "$PWD/peerings", directory to save existing peerings to
|
||||
"peerings": "/path/to/peering-config.json", // optional; default "$PWD/peerings", directory to save existing peerings to
|
||||
"production": true, //optional, default true;
|
||||
"debug-mode": false, // optional; whethet to enable debugging; default false
|
||||
"flask-secret-key": "<secret-please-replace>", // secret key for session cookies
|
||||
|
|
Loading…
Add table
Reference in a new issue