.. _start:

.. relock documentation service file, created by
   sphinx-quickstart on Wed May 14 18:37:20 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Run pre-built demo app
----------------------

This section shows how to set up the Relock service and to run the pre-built Flask demo application directly from its Docker container.

.. include:: relock_setup.rst

Set up demo app storage
~~~~~~~~~~~~~~~~~~~~~~~

The demo application requires persistent storage for storing user-related data (e.g., email, passwords, profile information). It is designed to use a MySQL database. To simplify setup and ensure a clean environment, we recommend starting with a fresh MySQL container. For enhanced security, Relock’s cryptographic keys are stored separately in a dedicated in-memory database.

.. code-block:: bash

   $ docker run --name mysql \
                --restart always \
                -v ./data/mysql:/var/lib/mysql \
                -e MYSQL_ROOT_PASSWORD=#SupperSecret123 \
                -e MYSQL_USER=admin \
                -e MYSQL_PASSWORD=#SupperHidden123 \
                -e MYSQL_DATABASE=demo \
                -d -it mysql \
                --character-set-server=utf8mb4

Start demo app container
~~~~~~~~~~~~~~~~~~~~~~~~

The Relock Flask demo container can be pulled and run directly. The source code is available for exploration or modification in the public GitHub repository (see :ref:`Run demo app from source <flask_github>` for details).

.. code-block:: bash

   $ docker run  -d --restart always \
                 --user root \
                 --privileged \
                 --network host \
                  -it relockid/demo run \
                 --host relock.demo \
                 --multiprocessing \
                 --ip 0.0.0.0 \
                 --port 443

To access the demo, open a web browser and navigate to ``https://relock.demo``. Since the SSL certificate was trusted in previous steps, the app should now be accessible over HTTPS without security warnings.