Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 5.28 KB

how-to-deploy-bold-reports-using-existing-db-server.md

File metadata and controls

52 lines (40 loc) · 5.28 KB
Raw

How to deploy Bold Reports using existing DB server?

In the following section, we are going to run the Bold Reports application by passing the application startup backend configuration environment variable using the existing DB server details.

  1. Download docker compose file using the following command.

    curl -o docker-compose.yml "https://raw.githubusercontent.com/boldreports/bold-reports-docker/master/deploy/single-container-with-env-variable/docker-compose.yml"

  2. Open the docker compose file and fill the mandatory fields - APP_BASE_URL, Unlock Key and Database details

    docker-compose-database-variable

    APP_BASE_URL Guidance:

    • Provide the HTTP scheme for APP_BASE_URL value. For example,
      http://example.com
      http://<public_ip_address>
    • For Windows and MacOS use either http://host.docker.internal. Docker Desktop provides host.docker.internal and gateway.docker.internal DNS for communication between docker applications and host machine. Please make sure that the host.docker.internal DNS has your IPv4 address mapped in your hosts file on Windows(C:\Windows\System32\drivers\etc\hosts).
    • For Linux use the Machine Public IP address as the value for APP_URL with the HTTP scheme.

    Environment variable Usage:

    Name Required Description
    BOLD_SERVICES_UNLOCK_KEY Yes License key for activating Bold Reports. Please refer to this document to download the key.
    If you don't have the download key option, please create a support ticket here.
    BOLD_SERVICES_DB_TYPE Yes Type of database server can be used for configuring Bold Reports.

    The following DB types are accepted:
    1. mssql – Microsoft SQL Server/Azure SQL Database
    2. postgresql – PostgreSQL Server
    3. mysql – MySQL/MariaDB Server
    BOLD_SERVICES_DB_HOST Yes Name of the Database Server
    BOLD_SERVICES_DB_PORT No The system will use the following default port numbers based on the database server type.
    PostgrSQL – 5234
    MySQL -3306

    Please specify the port number for your database server if it is configured on a different port.

    For MS SQL Server, this parameter is not necessary.
    BOLD_SERVICES_DB_USER Yes Username for the database server
    BOLD_SERVICES_DB_PASSWORD Yes The database user's password
    BOLD_SERVICES_DB_NAME No If the database name is not specified, the system will create a new database called bold services.

    If you specify a database name, it should already exist on the server.
    BOLD_SERVICES_POSTGRESQL_MAINTENANCE_DB Yes For PostgreSQL DB Servers, this is an optional parameter.
    The system will use the database name postgres by default.
    If your database server uses a different default database, please provide it here.
    BOLD_SERVICES_DB_ADDITIONAL_PARAMETERS No If your database server requires additional connection string parameters, include them here.

    Connection string parameters can be found in the official document.
    My SQL: https://dev.mysql.com/doc/connector-net/en/connector-net-8-0-connection-options.html
    PostgreSQL: https://www.npgsql.org/doc/connection-string-parameters.html
    MS SQL: https://docs.microsoft.com/en-us/dotnet/api/system.data.sqlclient.sqlconnection.connectionstring

    Note: A semicolon(;) should be used to separate multiple parameters.
    BOLD_SERVICES_USER_EMAIL Yes It should be a valid email.
    BOLD_SERVICES_USER_PASSWORD Yes It should meet our password requirements.

    Note:Password must meet the following requirements. It must contain at least 6 characters, 1 uppercase character, 1 lowercase character, 1 numeric character, 1 special character

  3. Run docker compose up command.

    docker-compose up -d

    docker-compose-up

    Note: The docker volumes boldservices_data and db_data persists data of Bold Reports and PostgreSQL respectively. Learn more about docker volumes

  4. After running the command, access the Bold Reports App by entering APP_URL in a browser.At this point, Bold Reports should be running in <app_base_url> (as appropriate)

    docker-startup

    Note: The Bold Reports site is not immediately available on port 80 because the containers are still being initialized and may take a couple of minutes for the first load.

Shutdown and Cleanup

The command docker-compose down removes the containers and default network, but preserves the volumes of Bold Reports and PostgreSQL.

The command docker-compose down --volumes removes the containers, default network, and all the volumes.