Skip to content

Latest commit

 

History

History
34 lines (20 loc) · 2.01 KB

README.md

File metadata and controls

34 lines (20 loc) · 2.01 KB
Raw

Zenbox local version for trilitech

Setup

  1. Install Docker Desktop: https://www.docker.com/products/docker-desktop/

  2. Open Docker Desktop and complete the setup

  3. Go to Settings -> Docker Engine -> add "insecure-registries": ["<IP address of the local registry>:5001"] to the JSON. This is to allow the local registry to be used.

  4. Clone this repository and cd into it

  5. Run start script

    # Make the script executable
chmod +x start.sh

# Run the script
./start.sh

  6. Now you can access Zenbox at https://localhost. Please ignore the certificate warning and proceed to the website.

    Further Details: When visiting a website, your browser expects a security certificate that has been verified by a trusted authority. This helps ensure the site is secure. However, because we're setting up the website to run directly on your computer, we use a local process to generate these certificates. These aren't recognized by standard authorities, which is why you're seeing the warning. To learn more about how these certificates are created, you can refer to the start-up script.
    Despite this, your data remains secure. It never leaves your computer. We use HTTPS encryption, which means even if someone could listen in on the data being sent to and from your computer (via loopback traffic), they would only see encrypted information, keeping your data safe.

(Optional) Viewing stored data

You can install MongoDB Compass to have a GUI access to the DB. You can find the credentials in .env file. We map the port 27017 to the host machine, so when you open MongoDB Compass, you can use mongodb://zenbox_mongo_user:password_here@localhost:27017/ as the URI.

If running Zenbox makes your system slower

To lower Zenbox's resource usage, navigate to Docker Desktop -> Settings -> Resources and decrease the CPU/Memory/Swap allocations. This will extend email processing times but may be a suitable trade-off for you.