Deployaroo Installation Guide¶
Installation Steps¶
1. Clone the Repository¶
git clone https://github.com/your-repo/deployaroo.git
cd deployaroo
2. Generate Encryption and Secret Keys¶
pip install cryptography
python3 ./generate_encryption_key.py
Run the script twice to generate two different keys:
- Use one for SECRET_KEY
- Use the other for ENCRYPTION_KEY
Remember these keys for the installation method you choose.
Installation Options¶
Choose one of the following installation methods:
A. Docker Run¶
-
Build the Docker Image:
docker build -t deployaroo .
-
Run the Docker Container:
docker run -d \ --name deployaroo-app \ --restart always \ -p 8000:8000 \ -e SECRET_KEY='your_secret_key' \ -e ENCRYPTION_KEY='your_encryption_key' \ -e APP_ADMIN_USER='admin' \ -e APP_ADMIN_PASSWORD='password' \ deployaroo \ gunicorn -w 10 -b :8000 run:app --timeout 3600
-
Access the Application: Open your browser and navigate to
http://<IP>:8000
.Login using the credentials you set in the Docker Run
B. Docker Compose (Recommended)¶
-
Create or modify docker-compose.yml:
version: '3' services: app: container_name: deployaroo-app restart: always build: . ports: - "8000:8000" environment: SECRET_KEY: 'your_secret_key' ENCRYPTION_KEY: 'your_encryption_key' APP_ADMIN_USER: 'admin' APP_ADMIN_PASSWORD: 'password' volumes: - ./deployaroo-data/logs:/home/project/app/logs - ./deployaroo-data/backups:/home/project/app/apps/backups command: gunicorn -w 10 -b :8000 run:app --timeout 3600 nginx: container_name: deployaroo-nginx restart: always image: "nginx:latest" ports: - "80:80" volumes: - ./nginx:/etc/nginx/conf.d depends_on: - app
-
Deploy:
docker-compose up --build -d
-
Access the Application: Open your browser and navigate to
http://<IP>:80
.Login using the credentials you set in the docker-compose.yml
C. General Linux¶
- Set Environment Variables:
export SECRET_KEY='your_generated_secret_key' export ENCRYPTION_KEY='your_generated_encryption_key'
Alternatively, update these values in ./apps/config.py
:
default_secret_key = 'your_generated_secret_key'
default_encryption_key = 'your_generated_encryption_key'
-
Install Dependencies:
pip install -r requirements.txt
-
Run the Application:
python3 app.py
-
Access the Application: Open your browser and navigate to
http://localhost:5000
.Login using the default credentials: admin / password
Next Step¶
To get started with Deployaroo, please refer to the Initial Setup Guide.
Simplify your VM deployments with Deployaroo
Get Started | View Demo (Coming soon) | Report Bug | Request Feature