diff --git a/README.md b/README.md new file mode 100644 index 0000000..a43853e --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# Flask IPAM (FIPAM) +An IP address management application _(Passive)_ written in **python** with the Flask web framework (and modules).
+The application is designed to manage **small networks** (**/30** to **/22**) destined for use in a **LAB**.
+_(I'm not an experienced developer, just a tinkerer)_ + +--- +![image](https://github.com/user-attachments/assets/a211c332-8ae8-4846-99f9-ebcda0d09c61) +![image](https://github.com/user-attachments/assets/40e240bd-481f-48bd-a67e-7007894f27b9) + +--- +![image](https://github.com/user-attachments/assets/44dac68f-e2e4-4d53-9158-9597de0dab5b) +![image](https://github.com/user-attachments/assets/5767a3dc-d99c-4c3e-bb88-c9c92049f58a) + +--- +- Installation : [here](install.md) +- Sources : [here](sources.md) diff --git a/install.md b/install.md new file mode 100644 index 0000000..3b16252 --- /dev/null +++ b/install.md @@ -0,0 +1,11 @@ +# Installation GUIDE +This documentation is very good, but needs a few changes to make it work (in our case) : +https://www.digitalocean.com/community/tutorials/how-to-serve-flask-applications-with-gunicorn-and-nginx-on-ubuntu-22-04
+ +- You don't need to create `wsgi.py`, when asked, replace : `wsgi:app` with `'app:create_app()'` . + - EX : For starting APP with gunicorn : `gunicorn --bind 0.0.0.0:5000 'app:create_app()'` + - In Service File, replace "ExecStart" line with :
+`ExecStart=/var/www/fipam/bin/gunicorn --workers 1 --bind unix:fipam.sock -m 007 'app:create_app()'`
+_(Adjust the number of workers to your needs)_ +- you must first run setup.py to create the admin user.
+_(it will create a second database in `./var/setup-instance`. It will have to be merged in the application database in `./var/app-instance`)_