BRIDGECLICK - SETUP GUIDE

--- REQUIREMENTS ---

* Docker Desktop 4.4+ or higher (includes Docker Compose V2) for Windows
* WSL2 (Windows Subsystem for Linux) - Recommended backend
* PowerShell or Command Prompt (CMD)


--- UNPACKING ---

1. Extract the downloaded archive (ZIP/RAR) to a folder on your computer.
   Example: C:\BridgeClick
2. Make sure all files (.env, docker-compose.yml, etc.) are inside 
   the same folder.


[!] IMPORTANT: All commands must be executed from the directory where the 'docker-compose.yml' file is located.
    1. Open your terminal (PowerShell is recommended).
    2. Use the 'cd' command to navigate to the folder where the 'docker-compose.yml' file is located.
       Example: cd C:\BridgeClick


--- SERVICE MANAGEMENT ---

# Start the application
docker compose up -d

# Restart the application
docker compose restart

# Stop the application
docker compose down


--- LOGS & MONITORING ---

# Check the status of all services
docker compose ps -a

# View logs for all services
docker compose logs -f

# View logs for a specific service (e.g., server)
docker compose logs -f server

(Press Ctrl+C to exit the log view)


--- UPDATING THE PROJECT ---

To update to a new version:
1. Update the 'APP_VERSION' value in the .env file.
2. Run the following commands in PowerShell:

# Pull the latest images
docker compose pull

# Apply updates
docker compose up -d


--- CONFIGURATION FILES ---

Before the first startup, check these files in the project folder:

* .env               : App version and public Port (Default: 80).
* db.env             : PostgreSQL credentials.
* server.env         : Backend and Redis connection settings.
* docker-compose.yml : Main configuration file.


--- ACCESS ---

Once started, the application is available at:
URL: http://<SERVER_IP>:<PORT>
(Default port: 80)

Article Details

Article ID:
2
Category: