Windows

SimpleAccounts-UAE is a web application for managing accounts. This README provides instructions for installing and running SimpleAccounts-UAE using Docker and Docker Compose.

Prerequisites

Before proceeding with the installation, please make sure you have the following prerequisites installed:

Git Installation

Setting up Git on Windows is a straightforward process. Follow these steps to get started:

  1. Download Git:

    • Visit the official Git website: https://git-scm.com/

    • Click on the "Download for Windows" button.

    • The download will start automatically. Once it's complete, run the installer.

  2. Install Git:

    • Run the downloaded Git installer.

    • You'll see a series of setup options:

      • Select the language you prefer for the installation process.

      • Click "Next" to proceed.

      • Read the license agreement and accept it.

      • Select "OpenSSL" option for HTTPS transport backend.

      • Click "Next" to proceed.

  3. Complete the Installation:

    • Choose your preferred terminal emulator for using Git commands (e.g., Git Bash, Command Prompt, PowerShell). Git Bash is highly recommended.

    • Click "Next" to begin the installation process.

    • When the installation is complete, click "Finish."

  4. Verify the Installation:

    • Open the terminal emulator you chose during installation (e.g., Git Bash).

    • To verify Git installation use below command. You should see the installed Git version in the terminal.

git --version

Here are detailed instructions to install Docker and Docker Compose on Windows OS:

Installing Docker on Windows

  1. Visit the Docker website: https://www.docker.com/get-started

  2. Click on the "Get Docker" button.

  3. On the next page, select "Docker Desktop for Windows" to download the installer.

  4. Once the download is complete, run the installer.

  5. During the installation process, you may be prompted to enable Hyper-V and Windows containers features. Make sure to enable them if requested.

  6. After the installation is complete, Docker Desktop will launch automatically.

  7. Docker Desktop may take a few minutes to start up. Once it's ready, you'll see the Docker icon in the system tray.

  8. Right-click on the Docker icon in the system tray and select "Settings".

  9. In the settings window, you can customise various Docker configurations such as resources, network, and more. You can review and adjust these settings according to your needs.

  10. Docker is now installed on your Windows machine. You can open a command prompt or PowerShell window and run docker --version to verify the installation. It should display the Docker version number.

Installing Docker Compose on Windows

  1. Open a web browser and go to the Docker Compose GitHub release page: https://github.com/docker/compose/releases

  2. Scroll down to the "Assets" section of the latest release.

  3. Under the "Assets" section, find the Windows executable file with the filename docker-compose-Windows-x86_64.exe and click on it to download.

  4. Rename the downloaded file to docker-compose.exe.

  5. Move the docker-compose.exe file to a directory that is included in your system's PATH environment variable. This will allow you to run Docker Compose from any command prompt or PowerShell window.

  6. Open a command prompt or PowerShell window and run docker-compose --version to verify the installation. It should display the Docker Compose version number.

Docker and Docker Compose are now successfully installed on your Windows machine. You can proceed with using them as described in your project's README.md file or other relevant documentation.

Note: Make sure to restart your computer after installing Docker and Docker Compose to ensure that all changes take effect properly.

To verify if Docker and Docker Compose are installed correctly, run the following commands:

docker --version
docker-compose --version

Make sure you see the version numbers for both commands.

Installation

  1. Clone the SimpleAccounts-UAE repository:

git clone https://github.com/SimpleAccounts/SimpleAccounts-UAE.git
cd SimpleAccounts-UAE

  1. Open the docker/docker-compose.yml file and review the environment variables defined under the backend service section. These variables control various aspects of the application, including SMTP configuration and database settings. It is recommended to change the default values, especially for sensitive information such as passwords.

  2. Start the application using Docker Compose:

docker-compose up -d

This command will download the required Docker images and start the containers in the background.

Access the SimpleAccounts-UAE application by opening your web browser and navigating to http://localhost:80.

Environment Variables

The following environment variables can be configured in the docker/docker-compose.yml file under the backend service section:

  • SIMPLEVAT_SMTP_USER: SMTP username for sending emails.

  • SIMPLEVAT_SMTP_PASS: SMTP password for authentication.

  • SIMPLEVAT_SMTP_HOST: SMTP server hostname.

  • SIMPLEVAT_SMTP_PORT: SMTP server port.

  • SIMPLEVAT_SMTP_AUTH: SMTP authentication method.

  • SIMPLEVAT_SMTP_STARTTLS_ENABLE: Enable STARTTLS for SMTP connection.

  • SIMPLEVAT_RELEASE: Application release version.

  • SIMPLEVAT_HOST: Application host URL.

  • SIMPLEVAT_DB_HOST: Hostname of the PostgreSQL database.

  • SIMPLEVAT_DB: Name of the PostgreSQL database.

  • SIMPLEVAT_DB_USER: PostgreSQL database username.

  • SIMPLEVAT_DB_PASSWORD: PostgreSQL database password.

  • SIMPLEVAT_DB_PORT: PostgreSQL database Port number.

It is recommended to review and update these variables according to your specific configuration.

Note: Please ensure that sensitive information, such as passwords, are stored securely and not committed to version control.

PreviousMac OSNextSetting permissions

Last updated