10 |
11 | ## 🐳 Setup
12 |
13 | ### Docker Run
14 |
15 | ```bash
16 | docker run -p 8080:8080 \
17 | -e SECRET_KEY=your_secret_key \
18 | -e PORT=8080 \
19 | -v ./instance:/app/instance \
20 | Portall
21 | ```
22 |
23 | ### Docker Compose
24 | ```yml
25 | version: '3'
26 | services:
27 | portall:
28 | image: need4swede/portall:latest
29 | container_name: portall
30 | ports:
31 | - "8080:8080"
32 | environment:
33 | - SECRET_KEY=your_secret_key
34 | volumes:
35 | - ./instance:/app/instance
36 | ```
37 |
38 | ## ✨ Core Functionality
39 |
40 | **Easy Port Management**
41 | - Easily add, remove and assign ports to different services and hosts.
42 |
43 | **Port Number Generation**
44 | - Quickly generate unique port numbers to host your applications.
45 |
46 | **Import Tools**
47 | - Import existing configurations by pasting your Caddyfile, Docker-Compose or JSON data.
48 |
49 | **Custom Rules**
50 | - Define your own port ranges and set exclusions for the port generator.
51 |
52 | ## 🎨 UI Goodies
53 |
54 | **Block Level Design**
55 | - Drag and drop elements to easily organize your ports and move applications between hosts.
56 |
57 | **Themes**
58 | - Ships with both Light and Dark modes, with more themes to come.
59 |
60 | **CSS Playground**
61 | - Want to style the UI yourself? You can modify the look and feel via Custom CSS support.
62 |
63 | **Mobile Responsive**
64 | - Manage your ports from anywhere with fully-responsive pages.
65 |
66 | ## 🛠️ Technical Stack
67 |
68 | - 🐍 **Backend**: Flask (Python)
69 | - 💾 **Database**: SQLAlchemy with SQLite
70 | - 🌐 **Frontend**: HTML, CSS, JavaScript
71 |
72 | ## 📸 Screenshots
73 |
74 | ### Port Management
75 | 
76 | 
77 |
78 | ### Port Generator
79 | 
80 | 
81 |
82 | ### Import Tool
83 | 
84 | 
85 |
86 | ### Settings
87 | 
88 | 
89 |
--------------------------------------------------------------------------------
/app.py:
--------------------------------------------------------------------------------
1 | # app.py
2 |
3 | # Standard Imports
4 | import logging
5 | import os
6 |
7 | # External Imports
8 | from flask import Flask
9 | from flask_migrate import Migrate, upgrade, stamp, current
10 | from sqlalchemy.exc import OperationalError
11 | from alembic.util import CommandError
12 |
13 | # Local Imports
14 | from utils.database import init_db
15 | from utils.routes import routes_bp
16 |
17 | # Setup logging
18 | logging.basicConfig(level=logging.DEBUG)
19 |
20 | def create_app():
21 | """
22 | Create and configure the Flask application.
23 |
24 | Returns:
25 | tuple: The configured Flask application instance and SQLAlchemy database instance.
26 | """
27 | # Create the Flask app
28 | app = Flask(__name__)
29 |
30 | # Environment variables
31 | app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('DATABASE_URL', 'sqlite:///portall.db')
32 | app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
33 | app.secret_key = os.environ.get('SECRET_KEY', 'M1Hd4l58YKm2Tqci6ZU65sEgWDexjuSfRybf2i4G')
34 |
35 | # Initialize database
36 | db = init_db(app)
37 |
38 | # Initialize Flask-Migrate
39 | migrate = Migrate(app, db)
40 |
41 | # Register the routes blueprint
42 | app.register_blueprint(routes_bp)
43 |
44 | return app, db
45 |
46 | def init_or_migrate_db(app, db):
47 | """
48 | Initialize a new database or migrate an existing one.
49 |
50 | This function handles four scenarios:
51 | 1. Database does not exist: Creates it and all tables.
52 | 2. Database exists, but no migration folder: Ensures all tables exist.
53 | 3. Database exists, migration folder exists, but no changes: No action needed.
54 | 4. Database exists, migration folder exists, and changes detected: Updates database.
55 |
56 | Args:
57 | app (Flask): The Flask application instance.
58 | db (SQLAlchemy): The SQLAlchemy database instance.
59 | """
60 | with app.app_context():
61 | # Check if migrations folder exists
62 | migrations_folder = os.path.join(os.path.dirname(__file__), 'migrations')
63 | migrations_exist = os.path.exists(migrations_folder)
64 |
65 | try:
66 | # Try to access the database
67 | db.engine.connect()
68 | logging.info("Existing database found.")
69 |
70 | if migrations_exist:
71 | logging.info("Migrations folder found. Checking for pending migrations...")
72 | try:
73 | # Get current migration version
74 | current_version = current(directory=migrations_folder)
75 |
76 | # Try to upgrade
77 | upgrade(directory=migrations_folder)
78 | new_version = current(directory=migrations_folder)
79 |
80 | if new_version != current_version:
81 | logging.info("Database updated successfully.")
82 | else:
83 | logging.info("Database is up-to-date. No migration needed.")
84 | except CommandError as e:
85 | if "Target database is not up to date" in str(e):
86 | logging.warning("Database schema has changed. Applying migrations...")
87 | upgrade(directory=migrations_folder)
88 | logging.info("Migrations applied successfully.")
89 | else:
90 | raise
91 | else:
92 | logging.info("No migrations folder found. Ensuring all tables exist...")
93 | db.create_all()
94 | logging.info("Database tables verified/created.")
95 | except OperationalError:
96 | logging.info("No existing database found. Creating new database and tables...")
97 | # If the database doesn't exist, create it and all tables
98 | db.create_all()
99 | if migrations_exist:
100 | # If migrations exist, stamp the database
101 | stamp(directory=migrations_folder)
102 | logging.info("New database created, all tables created, and stamped with latest migration version.")
103 | else:
104 | logging.info("New database and all tables created. No migrations to apply.")
105 |
106 | # Create the app and get the db instance
107 | app, db = create_app()
108 |
109 | # Run application
110 | if __name__ == '__main__':
111 | # Initialize or migrate the database before starting the app
112 | init_or_migrate_db(app, db)
113 |
114 | port = int(os.environ.get('PORT', 8080))
115 | debug_mode = os.environ.get('FLASK_DEBUG', 'False').lower() == 'true'
116 |
117 | logging.info(f"Starting Portall on port {port} with debug mode: {debug_mode}")
118 |
119 | app.run(debug=debug_mode, host='0.0.0.0', port=port)
--------------------------------------------------------------------------------
/changelog.md:
--------------------------------------------------------------------------------
1 | # v1.0.8
2 | ## Changed:
3 | ### Overhauled Docker-Compose Imports
4 | Complete rewrite of how docker-compose data is imported to make the import logic more versititle.
5 |
6 | # v1.0.7
7 | ## Added:
8 | ### Sorting
9 | You can now quickly sort your ports by port number or by protocol type. Manually sorting your ports via drag-and-drop is still supported.
10 | ### Database Migration
11 | Portall will now automatically migrate your database on version changes.
12 | ### Docker-Compose Anchors
13 | Added support for anchors in docker-compose imports. Port descriptions are still pulled from the image name.
14 | ## Changed:
15 | ### Restructured AJAX Calls
16 | Renamed and restructured all AJAX calls.
17 | ### Skip Existing Ports on Import
18 | Imports now skip adding ports that already exists in your database.
19 | ## Fixed:
20 | ### Missing Nicknames
21 | Fixed an issue where nicknames wouldn't get properly parsed when adding or importing ports.
22 | ### Moving Ports Creates Host
23 | Fixed a bug where moving a port from one host to another would register a new IP address.
24 | ### New Ports Missing Order
25 | Fixed a bug where newly added ports wouldn't have their order updated unless explicitly moved.
26 | ### Protocol Detection When Adding Ports
27 | Fixed a bug where port protocols wouldn't get caught for conflicts due to case-sensitivity.
28 |
29 | # v1.0.6
30 | ## Added:
31 | ### Port Protocols
32 | Portall now supports setting different protocols for ports (TCP/UDP).
33 |
34 | You can choose protocols when generating new ports (default is TCP), when creating new ones, and when editing existing ones. Two identical port numbers can both be registered to a single IP if they have different protocols. If you try to add an entry that already has a matching port and protocol, it will trigger the Port Conflict Resolver.
35 |
36 | If you add ports from an import, such as a Caddyfile or Docker-Compose, that doesn't explicitly state what protocols are being used, it will default to TCP.
37 | ### Loading Animation
38 | Certain actions, like port conflict resolutions and moving IP panels, now trigger a loading animation that prevents further action until the changes have registered.
39 | ## Changed:
40 | ### Database
41 | **Breaking Changes!** Database changes required for new port protocol feature.
42 | ### Docker-Compose Imports
43 | Now supports `/tcp` and `/udp` properties to differentiate between the two protocols.
44 | ## Fixed:
45 | ### Settings Reset
46 | Fixed an issue where certain settings would reset if you made changes in the settings.
47 |
48 | # v1.0.5
49 | ## Added:
50 | ### Data Export
51 | You can now export your entries to a JSON file.
52 | ## Changed:
53 | ### JSON Import
54 | Updated the format of JSON imports to match the new export,
55 | ## Fixed:
56 | ### Newly Added Port Order
57 | Fixed an issue where newly added ports would get placed near the beggining of the stack. Now they get appended to the end,
58 |
59 | # v1.0.4
60 | ## Added:
61 | ### Port Conflict Resolution
62 | In the event of moving a port to a different IP panel where the port is already registered, a new conflict resolution modal will present users with three options to choose from:
63 |
64 | - Change the number of the migrating port
65 | - Change the number of the existing port
66 | - Cancel the action
67 |
68 | This will prevent port conflicts when moving between hosts and give users an intuative way to migrate their ports and services over between IP's.
69 | ## Changed:
70 | ### Codebase Cleanup
71 | Refactored files and much of the code to make the applicaiton more modular.
72 | ## Fixed:
73 | ### Port Positioning
74 | Fixed a bug that would reset a port's position within an IP panel.
75 | ### Can't edit last port
76 | Fixed a bug that prevented users from editing the only remaining port in an IP panel.
77 |
78 | # v1.0.3
79 | ## Changed:
80 | ### Unique Port Numbers
81 | Port numbers now have to be unique within an IP panel. You cannot add a service using an already registered port number, nor can you change a port to a number that is already registered.
82 | ## Fixed:
83 | ### Port ID Bug
84 | Fixed an issue where the ID of a port wasn't being read correctly.
85 |
86 | Anchors aweigh! Refreshing Portall...
17 |{{ port.port_protocol }}
32 |Export all Port entries to a file.
168 | 169 |Purge all entries from the database. This action cannot be undone.
175 | 176 |