Jellystat Documentation

The Jellystat frontend entrypoint initializes internationalization (i18n) using i18next before mounting the React application.

Internationalization Configuration

• Fallback Language: en-GB
• Backend: Uses i18next-http-backend to load translation files from ${baseUrl}/locales/{{lng}}/{{ns}}.json.
• Language Detection: Detects language via a priority order: cookie, localStorage, sessionStorage, navigator, htmlTag, querystring, path, and subdomain. It caches the detected language in cookie.
• Interpolation: escapeValue is set to false.

Application Mounting

Once i18n is initialized, the application is rendered into the DOM element with ID root using the following structure:

1. React.StrictMode for development checks.
2. Suspense with a <Loading /> component as the fallback during lazy loading.
3. BrowserRouter using baseUrl as the basename to ensure correct routing relative to the deployment path.
4. The <App /> component as the root of the application.

i18n
  .use(Backend)
  .use(LanguageDetector)
  .use(initReactI18next)
  .init({
    fallbackLng: "en-GB",
    debug: false,
    backend: {
      loadPath: `${baseUrl}/locales/{{lng}}/{{ns}}.json`,
    },
    detection: {
      order: ["cookie", "localStorage", "sessionStorage", "navigator", "htmlTag", "querystring", "path", "subdomain"],
      cache: ["cookie"],
    },
    interpolation: {
      escapeValue: false,
    },
  })
  .then(() => {
    createRoot(document.getElementById("root")).render(
      <React.StrictMode>
        <Suspense fallback={<Loading />}>
          <BrowserRouter basename={baseUrl}>
            <App />
          </BrowserRouter>
        </Suspense>
      </React.StrictMode>
    );
  });

You can deploy Jellystat and its required PostgreSQL database using the provided docker-compose.yml configuration. The setup includes a jellystat service for the application and a jellystat-db service running postgres:18.1. The application service depends on the database being healthy before starting.

version: '3'

services:
  jellystat-db:
    image: postgres:18.1
    shm_size: '1gb'
    container_name: jellystat-db
    restart: unless-stopped
    logging:
      driver: "json-file"
      options:
        max-file: "5"
        max-size: "10m"
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: mypassword
    volumes:
      - postgres-data:/var/lib/postgresql
    healthcheck:
      test:
        - CMD-SHELL
        - pg_isready --dbname=postgres --username=postgres
      interval: 10s
      timeout: 5s
      retries: 5

  jellystat:
    image: cyfershepard/jellystat:latest
    container_name: jellystat
    restart: unless-stopped
    logging:
      driver: "json-file"
      options:
        max-file: "5"
        max-size: "10m"
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: mypassword
      POSTGRES_IP: jellystat-db
      POSTGRES_PORT: 5432
      JWT_SECRET: "my-secret-jwt-key"
      TZ: mytimezone
    volumes:
      - jellystat-backup-data:/app/backend/backup-data
    ports:
      - "3000:3000"
    depends_on:
      jellystat-db:
        condition: service_healthy
    healthcheck:
      test: wget --no-verbose --tries=1 --spider http://localhost:3000/auth/isConfigured || exit 1
      interval: 60s
      timeout: 30s
      retries: 5
      start_period: 30s

networks:
  default:

volumes:
  postgres-data:
  jellystat-backup-data:

Jellystat's entrypoint script supports loading sensitive configuration (secrets) from files using environment variables prefixed with FILE__.

When the container starts, the script looks for any environment variable starting with FILE__. It treats the value of that variable as a path to a file. It then reads the contents of that file and exports them as a new environment variable with the FILE__ prefix removed.

Example Behavior: If you set FILE__DATABASE_PASSWORD=/run/secrets/db_pass, the script will read the content of /run/secrets/db_pass and export it as DATABASE_PASSWORD.

Constraints:

• The file specified in the FILE__ variable must exist; otherwise, the container will exit with an error.
• If the resulting variable name (without the prefix) is already set in the environment, a warning will be printed to stdout, and the existing value will be overwritten by the file's content.