Setting up the web client

This is the web client specifically developed for the Chaosdorf.

While the server can communicate with everything, that understands HTTP, the web-client is usually, how people interact with it.

Getting started

Its expected, you already have a server setup. If not, follow this guide.

The primary way to set up the server is by using the docker container hosted under codeberg.org/chaosdorf/mete-client. It follows the release convention of the server: There are tags for different versions and two general ones:

• latest is the latest version, which can be considered stable.
• beta is often the most up-to-date version, but may also introduce bugs and untested behaviour.

Example compose

The only important section is client. The rest is just for a complete example

services:
  db:
    image: postgres
    # [...]

  server:
    image: codeberg.org/chaosdorf/mete-server:latest
    # [...]

  client:
    image: codeberg.org/chaosdorf/mete-client:beta
    container_name: metekasse-client
    restart: unless-stopped
    depends_on:
      server:
        condition: service_healthy
        restart: true

    ports:
      - "5000:5000"

    environment: 
      API_HOST: "http://server:8000"
      IMAGES_USE_PROXY: true

Configuration

The configuration are stored in environment variables.

The only required variable is API_HOST. It defines, where the client will look for the server. The API_HOST is expected to provide a GET /_market/version to check for compatability.

Failing to connect to the server or if it does not provide said endpoint will result in it locking up and asking you, the admin, to fix it. While version mismatch is not reason to lock up, it will recommend in the logs, that you might want to update.

For additional configuration, see: Configuration