readme-vars.yml

---

# project information
project_name: manyfold
project_url: "https://github.com/manyfold3d/manyfold/"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/manyfold-logo.png"
project_blurb: |
  [{{ project_name|capitalize }}]({{ project_url }})  is an open source, self-hosted web application for managing a collection of 3D models, particularly focused on 3D printing.
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
project_categories: "3D Printing"
# supported architectures
available_architectures:
  - {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
# container parameters
common_param_env_vars_enabled: true
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent storage for application configuration data."}
param_usage_include_env: true
param_env_vars:
  - {env_var: "DATABASE_URL", env_value: "", desc: "Database connection URL. For sqlite use `sqlite3:/config/manyfold.sqlite3`. For postgres or mariadb use `<scheme>://<username>:<password>@<hostname>:<port>/<db name>` where `<scheme>` is `postgresql` or `mysql2`. Special characters in username/password must be [URL encoded](https://en.wikipedia.org/wiki/Percent-encoding)."}
  - {env_var: "REDIS_URL", env_value: "", desc: "Redis/Valkey database URL in `redis://<hostname>:<port>/<db number>` format."}
  - {env_var: "SECRET_KEY_BASE", env_value: "", desc: "Browser session and database encryption key. If unset a random one will be generated on init, the database is locked to this key."}
param_usage_include_ports: true
param_ports:
  - {external_port: "3214", internal_port: "3214", port_desc: "Port for web frontend"}
opt_param_usage_include_vols: true
opt_param_volumes:
  - {vol_path: "/libraries", vol_host_path: "/path/to/libraries", desc: "Location of your 3D model libraries."}
readonly_supported: false
nonroot_supported: false
# application setup block
app_setup_block_enabled: true
app_setup_block: |
  This container *requires* a separate Redis/Valkey instance to run. Sqlite is supported but we recommend an external Postgres or MariaDB database for better performance.

  To generate keys for `SECRET_KEY_BASE` you can run `docker run --rm -it --entrypoint /bin/bash lscr.io/linuxserver/manyfold:latest generate-secret`.

  You don't have to use `/libraries` and you're not limited to a single path, you can mount as many arbitrary paths as you like as long as you make sure the permissions match the user running the container.

  For more information check out the [Manyfold documentation](https://manyfold.app/get-started/).
# init diagram
init_diagram: |
  "manyfold:latest": {
    docker-mods
    base {
      fix-attr +\nlegacy cont-init
    }
    docker-mods -> base
    legacy-services
    custom services
    init-services -> legacy-services
    init-services -> custom services
    custom services -> legacy-services
    legacy-services -> ci-service-check
    init-migrations -> init-adduser
    init-os-end -> init-config
    init-config -> init-config-end
    init-crontab-config -> init-config-end
    init-manyfold-config -> init-config-end
    init-config -> init-crontab-config
    init-mods-end -> init-custom-files
    init-adduser -> init-device-perms
    base -> init-envfile
    init-os-end -> init-manyfold-config
    base -> init-migrations
    init-config-end -> init-mods
    init-mods-package-install -> init-mods-end
    init-mods -> init-mods-package-install
    init-adduser -> init-os-end
    init-device-perms -> init-os-end
    init-envfile -> init-os-end
    init-custom-files -> init-services
    init-services -> svc-cron
    svc-cron -> legacy-services
    init-services -> svc-manyfold
    svc-manyfold -> legacy-services
  }
  Base Images: {
    "baseimage-alpine:3.23"
  }
  "manyfold:latest" <- Base Images
# changelog
changelogs:
  - {date: "13.01.26:", desc: "Rebase to Alpine 3.23."}
  - {date: "08.10.25:", desc: "Change key init to auto generate and persist."}
  - {date: "27.07.25:", desc: "Rebase to Alpine 3.22."}
  - {date: "12.01.25:", desc: "Rebase to Alpine 3.21."}
  - {date: "23.07.24:", desc: "Initial Release."}