# Django Gateway Interface
## Overview
**Django Gateway Interface** is a Django application designed to provide a user-friendly web interface for configuring Nginx settings for set request limit and IP block. This package enables users to easily manage gateway configurations, specifically to set request limits and block IP addresses at any endpoint for security purposes. It supports both Windows and Linux environments, allowing for seamless integration and efficient configuration management based on user input.
**Make sure Selected Operating System is same as your working environment**
## Features
- User-friendly interface for gateway configuration.
- Integration with Nginx to apply and manage configurations.
- Easy installation via PyPI.
- Support Windows and Linux even in WSL
## Installation
You can install the Django Gateway Interface package from PyPI using pip. Make sure you have Python 3.8 or higher and Django 3.0 or higher installed.
```
pip install gateapp
```
Once verify it using and version should be 2.1.5
```
pip show gateapp
```
## Requirement
- Make sure your django app is running on http://127.0.0.1:8000, needed some modification in setting.py for template and css and follow configuration
## Configuration
Add to Installed Apps:
Add 'gateapp' to your INSTALLED_APPS in your Django settings.py:
```
import os
```
```
INSTALLED_APPS = [
...
'gateapp',
...
]
```
```
TEMPLATES = [
{
...
'DIRS': [os.path.join(BASE_DIR, 'templates')],
...
},
]
```
```
# Optionally include additional static file directories
STATIC_URL = '/static/'
STATICFILES_DIRS = [
os.path.join(BASE_DIR, 'static'),
]
```
**Database Migrations**:
Run the following command to apply database migrations for the Django app:
```
python manage.py migrate
```
**Static Files:**
Collect static files for the Django app:
```
python manage.py collectstatic
```
**URL Configuration**:
Include the URLs for the Gateway Interface in your Django project urls.py:
```
from django.urls import path, include
urlpatterns = [
# Other URL patterns
path('configure/', include('gateapp.urls'))
]
```
**Nginx Configuration:**
Configure Nginx to serve your Django application. Here’s a basic Nginx configuration example for windows:
```
server {
listen 80;
server_name yourdomain.com;
location / {
proxy_pass http://127.0.0.1:8000;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
}
location /static/ {
alias /path/to/your/static/files/;
}
location /media/ {
alias /path/to/your/media/files/;
}
}
```
Replace yourdomain.com and file paths with your specific details.
**Usage**
Run the Django Development Server:
Start the Django development server to test your installation:
```
python manage.py runserver
```
**Access the Interface**:
Open your web browser and navigate to http://localhost:8000/configure to access the Gateway Interface.
## Configure Gateway Settings:
Use the web interface to fill in and submit configuration details for the gateway.
## Contributing
Contributions are welcome! To contribute to the Django Gateway Interface:
**Fork the repository on GitHub**
Create a new branch for your changes.
Make your changes and test them.
Submit a pull request with a clear description of your changes.
## License
This project is licensed under the MIT License - see the LICENSE file for details.
**Thank you for using Django Gateway Interface! If you encounter any issues or have suggestions, please feel free to open an issue on GitHub or contact us directly.**
Raw data
{
"_id": null,
"home_page": "https://github.com/ankit3388/BlockerGateway",
"name": "gateapp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "django gateway interface web configuration",
"author": "Ankit Kumar",
"author_email": "bantiyadav16095@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f4/16/d12d9d4adaddd6f03a5f85fe899df63ba2b02ed960d57f6c165343edf7a6/gateapp-2.1.5.tar.gz",
"platform": null,
"description": "# Django Gateway Interface\r\n\r\n## Overview\r\n\r\n**Django Gateway Interface** is a Django application designed to provide a user-friendly web interface for configuring Nginx settings for set request limit and IP block. This package enables users to easily manage gateway configurations, specifically to set request limits and block IP addresses at any endpoint for security purposes. It supports both Windows and Linux environments, allowing for seamless integration and efficient configuration management based on user input.\r\n**Make sure Selected Operating System is same as your working environment** \r\n\r\n## Features\r\n\r\n- User-friendly interface for gateway configuration.\r\n- Integration with Nginx to apply and manage configurations.\r\n- Easy installation via PyPI.\r\n- Support Windows and Linux even in WSL\r\n\r\n## Installation\r\n\r\nYou can install the Django Gateway Interface package from PyPI using pip. Make sure you have Python 3.8 or higher and Django 3.0 or higher installed.\r\n\r\n```\r\npip install gateapp\r\n\r\n```\r\nOnce verify it using and version should be 2.1.5\r\n\r\n```\r\npip show gateapp\r\n\r\n```\r\n \r\n## Requirement\r\n- Make sure your django app is running on http://127.0.0.1:8000, needed some modification in setting.py for template and css and follow configuration \r\n\r\n## Configuration \r\nAdd to Installed Apps:\r\nAdd 'gateapp' to your INSTALLED_APPS in your Django settings.py:\r\n\r\n```\r\nimport os\r\n```\r\n\r\n```\r\nINSTALLED_APPS = [\r\n ...\r\n 'gateapp',\r\n ...\r\n]\r\n```\r\n```\r\nTEMPLATES = [\r\n {\r\n ...\r\n 'DIRS': [os.path.join(BASE_DIR, 'templates')],\r\n\r\n ...\r\n },\r\n]\r\n```\r\n\r\n```\r\n# Optionally include additional static file directories\r\nSTATIC_URL = '/static/'\r\nSTATICFILES_DIRS = [\r\n os.path.join(BASE_DIR, 'static'), \r\n \r\n]\r\n```\r\n**Database Migrations**:\r\nRun the following command to apply database migrations for the Django app:\r\n```\r\npython manage.py migrate\r\n```\r\n\r\n**Static Files:**\r\nCollect static files for the Django app:\r\n\r\n```\r\npython manage.py collectstatic\r\n```\r\n\r\n**URL Configuration**:\r\nInclude the URLs for the Gateway Interface in your Django project urls.py:\r\n\r\n```\r\nfrom django.urls import path, include\r\nurlpatterns = [\r\n # Other URL patterns\r\n path('configure/', include('gateapp.urls'))\r\n]\r\n```\r\n**Nginx Configuration:**\r\nConfigure Nginx to serve your Django application. Here\u00e2\u20ac\u2122s a basic Nginx configuration example for windows:\r\n\r\n```\r\nserver {\r\n listen 80;\r\n server_name yourdomain.com;\r\n\r\n location / {\r\n proxy_pass http://127.0.0.1:8000;\r\n proxy_set_header Host $host;\r\n proxy_set_header X-Real-IP $remote_addr;\r\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\r\n proxy_set_header X-Forwarded-Proto $scheme;\r\n }\r\n\r\n location /static/ {\r\n alias /path/to/your/static/files/;\r\n }\r\n\r\n location /media/ {\r\n alias /path/to/your/media/files/;\r\n }\r\n}\r\n```\r\nReplace yourdomain.com and file paths with your specific details.\r\n\r\n**Usage**\r\n\r\nRun the Django Development Server:\r\nStart the Django development server to test your installation:\r\n\r\n```\r\npython manage.py runserver\r\n```\r\n\r\n**Access the Interface**:\r\nOpen your web browser and navigate to http://localhost:8000/configure to access the Gateway Interface.\r\n\r\n## Configure Gateway Settings:\r\nUse the web interface to fill in and submit configuration details for the gateway.\r\n\r\n## Contributing\r\nContributions are welcome! To contribute to the Django Gateway Interface:\r\n\r\n**Fork the repository on GitHub**\r\nCreate a new branch for your changes.\r\nMake your changes and test them.\r\nSubmit a pull request with a clear description of your changes.\r\n\r\n## License\r\nThis project is licensed under the MIT License - see the LICENSE file for details.\r\n\r\n\r\n\r\n**Thank you for using Django Gateway Interface! If you encounter any issues or have suggestions, please feel free to open an issue on GitHub or contact us directly.**\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A Django application for configuring gateway settings with a web-based interface",
"version": "2.1.5",
"project_urls": {
"Bug Reports": "https://github.com/ankit3388/BlockerGateway/issues",
"Homepage": "https://github.com/ankit3388/BlockerGateway",
"Source": "https://github.com/ankit3388/BlockerGateway"
},
"split_keywords": [
"django",
"gateway",
"interface",
"web",
"configuration"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ab2c682ce1ae7aeb61244f78ba38023d3ef8d09c7febe4a6840c3a58eeb8a954",
"md5": "e9956681ca51b73e7d2c4362079aecea",
"sha256": "f96fc2ba66120521d0bda1c3ea47c535e5f65d3639ee7557108cc357a2d9393e"
},
"downloads": -1,
"filename": "gateapp-2.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e9956681ca51b73e7d2c4362079aecea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14191952,
"upload_time": "2024-07-10T12:07:28",
"upload_time_iso_8601": "2024-07-10T12:07:28.132872Z",
"url": "https://files.pythonhosted.org/packages/ab/2c/682ce1ae7aeb61244f78ba38023d3ef8d09c7febe4a6840c3a58eeb8a954/gateapp-2.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f416d12d9d4adaddd6f03a5f85fe899df63ba2b02ed960d57f6c165343edf7a6",
"md5": "4eb9d72840551580b84d230828db270d",
"sha256": "b862b0b48443a04bc9e22d0f1ae2ea6752398c45c3f92b067a303034e16d1d50"
},
"downloads": -1,
"filename": "gateapp-2.1.5.tar.gz",
"has_sig": false,
"md5_digest": "4eb9d72840551580b84d230828db270d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 14192826,
"upload_time": "2024-07-10T12:08:00",
"upload_time_iso_8601": "2024-07-10T12:08:00.981658Z",
"url": "https://files.pythonhosted.org/packages/f4/16/d12d9d4adaddd6f03a5f85fe899df63ba2b02ed960d57f6c165343edf7a6/gateapp-2.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-10 12:08:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ankit3388",
"github_project": "BlockerGateway",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "gateapp"
}
JSON
