readme-vars.yml

---

# project information
project_name: ubooquity
project_url: "https://vaemendis.net/ubooquity/"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/ubooquity-banner.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) is a free, lightweight and easy-to-use home server for your comics and ebooks. Use it to access your files from anywhere, with a tablet, an e-reader, a phone or a computer."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
project_categories: "Books"
# 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 }}"
opt_param_usage_include_env: true
opt_param_env_vars:
  - {env_var: "MAXMEM", env_value: "", desc: "To set the maximum memory. ( ex: set '1024' for 1GB )"}
param_usage_include_vols: true
param_volumes:
  - {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/data", desc: "Config files and database for ubooquity."}
  - {vol_path: "/books", vol_host_path: "/path/to/books", desc: "Location of books."}
  - {vol_path: "/comics", vol_host_path: "/path/to/comics", desc: "Location of comics."}
  - {vol_path: "/files", vol_host_path: "/path/to/raw/files", desc: "Location of raw files."}
param_usage_include_ports: true
param_ports:
  - {external_port: "2202", internal_port: "2202", port_desc: "The library port."}
  - {external_port: "2203", internal_port: "2203", port_desc: "The admin port."}
# application setup block
app_setup_block_enabled: true
app_setup_block: |
  Access the admin page at `http://<your-ip>:2203/ubooquity/admin` and set a password.

  Then you can access the webui at `http://<your-ip>:2202/ubooquity/`

  This container will automatically scan your files at startup.

  ### MAXMEM

  The quantity of memory allocated to Ubooquity depends on the hardware your are running it on. If this quantity is too small, you might sometime saturate it with when performing memory intensive operations. That’s when you get `java.lang.OutOfMemoryError:` Java heap space errors.

  You can explicitly set the amount of memory Ubooquity is allowed to use (be careful to set a value lower than the actual physical memory of your hardware). Value is a number of megabytes ( put just a number, without MB )

  If no value is set it will default to 512MB.
# init diagram
init_diagram: |
  "ubooquity: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-ubooquity-config -> init-config-end
    init-os-end -> init-crontab-config
    init-mods-end -> init-custom-files
    base -> init-envfile
    base -> init-migrations
    base -> init-mods
    init-config-end -> init-mods
    init-mods -> init-mods-end
    init-mods-package-install -> init-mods-end
    init-mods -> init-mods-package-install
    base -> init-os-end
    init-adduser -> init-os-end
    init-envfile -> init-os-end
    init-migrations -> init-os-end
    init-custom-files -> init-services
    init-mods-end -> init-services
    init-config -> init-ubooquity-config
    init-services -> svc-cron
    svc-cron -> legacy-services
    init-services -> svc-ubooquity
    svc-ubooquity -> legacy-services
  }
  Base Images: {
    "baseimage-alpine:3.20"
  }
  "ubooquity:latest" <- Base Images
# changelog
changelogs:
  - {date: "06.06.24:", desc: "Rebase to Alpine 3.20."}
  - {date: "20.03.24:", desc: "Rebase to Alpine 3.19."}
  - {date: "29.10.23:", desc: "Bump JRE to 17 to support v3."}
  - {date: "12.07.23:", desc: "Rebase to Alpine 3.18."}
  - {date: "04.07.23:", desc: "Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf)"}
  - {date: "05.03.23:", desc: "Rebase to Alpine 3.17."}
  - {date: "10.10.22:", desc: "Rebasing to alpine 3.16, migrate to s6v3."}
  - {date: "23.01.21:", desc: "Rebasing to alpine 3.13."}
  - {date: "01.06.20:", desc: "Rebasing to alpine 3.12."}
  - {date: "19.12.19:", desc: "Rebasing to alpine 3.11."}
  - {date: "28.06.19:", desc: "Rebasing to alpine 3.10."}
  - {date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag."}
  - {date: "22.02.19:", desc: "Rebasing to alpine 3.9."}
  - {date: "28.01.19:", desc: "Add pipeline logic and multi arch."}
  - {date: "15.10.18:", desc: "Upgrade to Ubooquity 2.1.2."}
  - {date: "23.08.18:", desc: "Rebase to alpine 3.8."}
  - {date: "09.12.17:", desc: "Rebase to alpine 3.7."}
  - {date: "07.10.17:", desc: "Upgrade to Ubooquity 2.1.1."}
  - {date: "16.07.17:", desc: "Upgrade to Ubooquity 2.1.0, see setting up application section for important info for existing v1.x users."}
  - {date: "26.05.17:", desc: "Rebase to alpine 3.6."}
  - {date: "08.04.17:", desc: "Switch to java from 3.5 repo, fixes login crashes."}
  - {date: "06.02.17:", desc: "Rebase to alpine 3.5."}
  - {date: "06.12.16:", desc: "Initial Release."}