Deployment Overview of Amnezia on Server¶

Prerequisites and Basic Requirements¶

The deployment of Amnezia requires a server environment with the following baseline configurations:

Operating System: Debian-based Linux distributions are supported.
Privileges: Root access or sudo privileges are required to execute installation scripts and manage system services.
Network: The server must have outbound internet access to download dependencies and certificates.
Ports: Specific ports must be open to allow traffic for the Amnezia panel and associated services.

FQDN of the Final Panel¶

The Amnezia panel is accessible via a subdomain on the hostkey.in domain. The fully qualified domain name (FQDN) follows the format:

<prefix><Server ID>.hostkey.in:<port>

Where <prefix> and <Server ID> are dynamically assigned based on the hosting environment, and <port> corresponds to the configured HTTP or HTTPS port for the panel.

Application Installation Process¶

The Amnezia application is installed using a dedicated installer script that automates the setup process. The installation workflow includes the following stages:

Authentication and token retrieval from the management API.
Verification of server connectivity.
Execution of installation tasks, including dependency resolution and service configuration.
Tagging the server with the webpanel identifier to link it to the documentation resource: https://hostkey.com/documentation/marketplace/security/amnezia/.
Finalization of scripts and notification of deployment completion.

The installer ensures that all necessary components are deployed in the correct sequence, resulting in a fully functional Amnezia instance.

Access Rights and Security¶

Security measures are implemented during the deployment to restrict unauthorized access:

Firewall rules are configured to allow only necessary traffic.
User permissions are set to limit access to administrative functions.
The application runs with restricted privileges to minimize potential security risks.

Available Ports for Connection¶

The following ports are utilized by the Amnezia deployment:

Port 80: HTTP traffic for initial setup and certificate generation.
Port 443: HTTPS traffic for secure access to the Amnezia panel.
Additional ports may be required for specific Amnezia protocols and services, depending on the configuration.

Starting, Stopping, and Updating¶

Service management for Amnezia is handled through standard system commands. The following operations are supported:

Start: systemctl start amnezia
Stop: systemctl stop amnezia
Restart: systemctl restart amnezia
Status: systemctl status amnezia
Update: The application can be updated by re-running the installation script or applying updates via the management interface.

Location of Configuration Files and Data¶

Configuration files and data for Amnezia are stored in the following locations:

Configuration directory: /etc/amnezia/
Data directory: /var/lib/amnezia/
Log files: /var/log/amnezia/

These directories contain all necessary files for the operation and maintenance of the Amnezia application.