aboutsummaryrefslogtreecommitdiffstats
path: root/fap/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'fap/README.md')
-rw-r--r--fap/README.md27
1 files changed, 15 insertions, 12 deletions
diff --git a/fap/README.md b/fap/README.md
index f41e879..f07a968 100644
--- a/fap/README.md
+++ b/fap/README.md
@@ -9,24 +9,27 @@ Licensed under the GNU GPL, version 2. See the included COPYING file.
## Usage
-Launch the python scripts for fap from tgmanage directory.
+### Installation/configuration
+* Install apache2, postgresql, php, php-cli, python3, python-psycopg2
+* Configure Postgresql with user + db name "fap", and password to your liking
+* Create DB tables from database/create_tables.sql
+* Configure Apache, necessary config in fap/httpd/apache_base_config
+* Enable mod_rewrite in Apache - "a2enmod rewrite"
+* Start/restart Apache
-### HTTPD
- j@lappie:~/git/tgmanage$ sudo python3 fap/httpd/server_http.py
-
-Example: <a href="httpd/terminal.log">httpd/terminal.log</a>
-
-
-### DHCPD
- j@lappie:~/git/tgmanage$ sudo python3 fap/dhcpd/server_dhcp.py
-
-Example: <a href="dhcpd/terminal.log">dhcpd/terminal.log</a>
+### FAP workflow
+* planning.cpp generates switches.txt and patchlist.txt
+* "php -f fap/tools/create_queries/create_queries.php" generates SQL queries
+* Manually insert queries from create_queries.php into DB
+* "php -f fap/tools/generate_distro_config_ae_event-options/generate.php" generates distroconfig into generated_configs/<distro>
+* Copy distro config from generated_configs/* to HTTPD (fap/httpd/files/), and load them from the distros (load merge <ip>/files/<distro>.conf in configure mode)
+* Start FAP DHCPD (sudo python3 fap/dhcpd/server_dhcp.py)
# TODO
* DONE: Support for IPv6 management
-* Process multiple HTTP request simultaneously
+* DONE: Process multiple HTTP request simultaneously
* Support for only pushing JunOS image to switch - no config (for backup switches)
* Try/catch on whole ethernet frame in DHCPD
* Timestamps on each line in log both from DHCPD and HTTPD