Exolynk

Installing

How to install the system.

Requirements

To use the system we recommend at least the following systems and their individual requirements. With more workloads and usage of the system this values need to be adopted.

Application Server The application server need to host the Exolynk docker/podman container with at least the following ressources available:

  • CPU: 2x1GHz
  • RAM: 1GB
  • SSD: 5GB

Database The Exolynk platform requires the PostgreSQL databse with the minimum version of 14.6 installed and setup. Please ensure that you backup the databse regulary on your own.

  • CPU: 1GHz
  • RAM: 1GB
  • SSD: 5GB

Storage The Exolynk platform requires a storage volume mounted into the application sever to store the uploaded binary files. Please ensure that you backup the files regulary on your own.

  • CPU: 1GHz
  • RAM: 1GB
  • SSD: 50GB

Services The Exolynk plarform relies on external services for certain functionality. These services should be provided to enusre a seamless expierence.

  • System SMTP Account: This is beeing used to send system mails
  • Marketing SMTP Account: This is beeing used to send marketing mails
  • TogetherAI API Key: This provider is used for all AI functionalities

Installation

  1. Ensure that you have received the access to the Exolynk container registry with repository name, path, user and password
  2. Ensure you have the logins for the SMTP system and marketing account available
  3. Ensure that you have a valid API-Key from TogetherAI
  4. Please install and setup the storage volume first, which can be access by the application container.
  5. Setup and install the database, that it is available for the application container
  6. Add the Exolynk repository to your docker/podman installation
  7. Start a new Exolynk container with the newest version and the config from the next chapter

Application Environment Variables

exo_log_color: false                    # Enable or disable colored log print to stdout
log_level: info                         # The level a single log need to have
log_max_level: trace                    # The max detail level of a log

exo_postgres_url: localhost             # set the url to the database
exo_postgres_user: postgres             # set the database user
exo_postgres_pwd: pwd                   # set the database password

exo_server_static_dir: ../www           # set the path to the static frontend
exo_server_docs_dir = ../docs/public    # set the path to the docs frontend
exo_server_url: 0.0.0.0:8080            # set the server adress and port
exo_public_url: http://127.0.0.1:8080   # set the public url for the server

exo_session_private_key: ***            # private key for session encryption
exo_vapid_private_key: ***              # private key (base64) for push notifications

exo_together_api_key: ***               # api access key for llm access

exo_smtp_url: "smtp.your.domain"        # Url to your SMTP server
exo_smtp_user: "***"                    # Username for the SMTP server
exo_smtp_pwd: "***"                     # Password for the SMTP user
exo_smtp_email: "system@exolynk.app"    # Mail of the dafult sender

exo_smtp_marketing_url = "smtp.your.domain"
exo_smtp_marketing_user = "***"
exo_smtp_marketing_pwd = "***"
exo_smpt_marketing_email = "Exolynk App <marketing@exolynk.app>"
Detail Settings →