Deployment Overview of Amnezia on Server¶

Prerequisites and Basic Requirements¶

To ensure a successful deployment of the Amnezia application, the following requirements must be met:

• Operating System: A compatible Linux distribution (e.g., Debian).

• Privileges: Root or sudo access is required to perform installation tasks and manage system services.

• Network Connectivity: The server must have outbound internet access to communicate with external APIs and download necessary components.

File and Directory Structure¶

The application deployment involves several configuration and data management paths:

• Configuration Files: Managed during the setup process to ensure correct environment settings.

• Application Data: Stored in designated system directories to maintain persistence across service restarts.

Application Installation Process¶

The installation of Amnezia is performed through a multi-stage automated deployment sequence that configures the host environment and initializes the application components. The process follows these stages:

1. Environment Authentication: The system retrieves necessary API tokens to authorize communication with management services.

2. Server Data Retrieval: System information is gathered to tailor the installation to the specific hardware and network configuration of the host.

3. System Readiness Check: The deployment process waits for a stable connection to the client machine before proceeding.

4. Deployment Execution: A sequence of automated steps installs dependencies, configures system settings, and initializes the application environment.

5. Finalization: Post-installation scripts are executed to finalize the service setup and ensure all components are running correctly.

Access Rights and Security¶

Security is maintained through several layers:

• Access Control: The installation process integrates with management APIs to track deployment stages.

• System Integrity: Automated checks ensure that the host environment is ready for secure application execution.

Docker Containers and Their Deployment¶

The application utilizes containerization technology to isolate services and ensure consistent runtime environments.

(Note: Specific image names and environment variables are determined during the active installation phase based on the server configuration.)

Custom Scripts and Additional Setup¶

The deployment includes specialized scripts to handle post-installation tasks:

• Finalization Scripts: These scripts run after the core components are installed to perform final system adjustments, cleanup of temporary files, and ensure the application is in a production-ready state.

• Management Integration: The installation process interacts with external management APIs to report deployment status (e.g., "installation started", "stage completion", and "deployment finished").

Application Update Instructions¶

To update the Amnezia application:

1. The system utilizes containerized services; therefore, updates are primarily managed by pulling the latest images and recreating the containers.

2. Standard procedure involves executing a pull command for the specific application images followed by a restart of the service to apply changes.

Available Ports for Connection¶

Connection to the application is made through standard web ports:

• HTTPS: 443 (Secure access via SSL)

• HTTP: 80 (For initial redirection or non-secure traffic)