Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: m-manar-d <161944563+m-manar-d@users.noreply.github.com>
  • Loading branch information
m-manar-d committed Mar 6, 2024
1 parent 1eff724 commit 654ee3f
Showing 1 changed file with 18 additions and 20 deletions.
38 changes: 18 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,47 @@
A bandwidth limiters' manager to manage simple-queues configured on one or more Mikrotik devices.

## A bandwidth limiters' manager to manage simple-queues configured on one or more Mikrotik devices.

This started as a quick and practical solution to reduce the work load and avoid recurring errors while editing simple queues in multiple Mikrotik routers that are performing bandwidth limiting for customers of an ISP.


Limitations:
### Limitations:

- Before using this app, currently configured [Queue types] and [Simple queues] must be matched in each router that will be added, or else after adding the first one, the next added routers will stay in a "sync" state, which means the app will not attempt to apply any changes to them when editing simple queues later.
- This app doesn't have a user entry evaluation mechanism yet, so when editing or configuring new simple queues, care must be taken to avoid errors (usually you will get a Server Error (500) if the command was rejected by the Mikrotik router).
- In the event of Server Error (500), just click the back button in your browser and check for errors.
- For creating new simple queues, the recommended approach is to edit an existing one, then click (Save as new) instead of (Save).


Installation:

### Installation:

1- apt install docker-compose
1- `apt install docker-compose`

2- cd /opt
2- `cd /opt`

3- git clone https://github.com/m-manar-d/mt_queue_mgr.git
3- `git clone https://github.com/m-manar-d/mt_queue_mgr.git`

4- cd mt_queue_mgr
4- `cd mt_queue_mgr`

5- nano .env
5- `nano .env`

6- cp sample.yml docker-compose.yml
6- `cp sample.yml docker-compose.yml`

7- docker-compose build
7- `docker-compose build`

8- docker-compose up -d
8- `docker-compose up -d`

9- docker exec -it mt_queue_mgr python manage.py collectstatic
9- `docker exec -it mt_queue_mgr python manage.py collectstatic`

10- docker exec -it mt_queue_mgr python manage.py makemigrations
10- `docker exec -it mt_queue_mgr python manage.py makemigrations`

11- docker exec -it mt_queue_mgr python manage.py migrate
11- `docker exec -it mt_queue_mgr python manage.py migrate`

12- http://ip-address
12- `http://ip-address`


Notes:
### Notes:

- This installation will run two containers, one for NGINX as a reverse-proxy and a second for the app.
- In step 5, it is very important to change the SECRET_KEY and admin credentials that will be used to login to the app. also edit DIRPATH in case you want a different installation path.
- If you are already using Docker, you can copy from sample.yml to your main docker-compose.yml and edit as needed; in this case, you will not need steps 1 and 6 to 8.
- If you are already using NGINX reverse-proxy, you can check nginx/conf/first.conf and copy/edit what you need to your NGINX config file.
- This was tested on Debian 12.

### Finally, any suggestion or advise is welcome and appreciated :)

0 comments on commit 654ee3f

Please sign in to comment.