Other ways to install
On Synology, install the native Frameleaf Manager app with Package Center → Manual Install. For other supported hosts, start with Frameleaf Manager for guided installation. Use manual Docker Compose setup when you want to own the container configuration yourself.
Manual container routes use files and images from one matching Frameleaf release. The Synology package installs Manager, which then installs the library from an eligible authenticated release.
Portainer
Section titled “Portainer”- Download
docker-compose.ymlandexample.envfrom the latest photo application release. - In Portainer, create a Stack and paste the Compose file.
- Replace the server’s
.envreference underenv_filewithstack.env. The machine learning service’s optional.env.mlentry can stay as it is. - Add the release’s environment variables in the stack editor. Set an absolute
UPLOAD_LOCATION, a newDB_DATA_LOCATIONon local disk and a randomDB_PASSWORD. - Set
FRAMELEAF_VERSION=latest, keep the database image supplied by the Compose file, then deploy. - Open the server on port
2283and complete First steps.
If your editor only accepts one Compose file, copy the hardware settings you need straight into the service. See Hardware acceleration.
Install script
Section titled “Install script”The repository’s install.sh is a small helper for a fresh manual installation. It creates a new frameleaf-app folder, downloads the latest release’s Compose file and environment example, checks them against the release’s checksums, generates a database password, and starts the stack. It requires Docker, Compose and curl.
Download and review the script from the release or source revision you want, then run it with Bash from a new parent directory. The script won’t overwrite an existing frameleaf-app folder, which protects any library and database already there. Choose a new parent directory instead of deleting the old folder.
For control over storage paths before the first start, use the manual guide instead.
Containers running as a non-root user
Section titled “Containers running as a non-root user”The release’s docker-compose.rootless.yml runs its services as user and group 1000:1000. Use it in place of the regular Compose file. It sets the service user; your Docker daemon stays as it is.
Create the library, PostgreSQL, ml-model-cache and studio-worker host folders before starting it, owned by that user. A folder Docker creates for you is owned by root, so the services can’t write to it. The rootless file has no network discovery helper, so type the server address in the phone apps. If you change the UID or GID, change it consistently in the Compose file and folder ownership. Keep the PostgreSQL parent mount at /var/lib/postgresql.
NAS systems
Section titled “NAS systems”Synology: obtain the released Frameleaf-supplied SPK and matching checksum, verify the file, then use Package Center → Manual Install on DSM 7.2.2-72806 or later with Container Manager 1432 or later. Open the app from the DSM main menu using the configured DSM HTTPS origin and create its administrator account. Library setup installs an eligible application release. See the Synology guide.
Unraid and TrueNAS: follow the Unraid or TrueNAS guide and use the installation files supplied for your platform and release.
HexOS: paste the Frameleaf install script into Custom Install. A listing in the HexOS app catalog is coming soon. See the HexOS guide.
A rented server
Section titled “A rented server”A Linux VM works with the same installation guides. Give it enough storage for originals, generated files and backups. Serve the app over HTTPS, and keep the database and Manager administration private. See Reverse proxy.
Kubernetes and all-in-one images
Section titled “Kubernetes and all-in-one images”Frameleaf installs with Manager or the release’s Compose configuration. There’s no supported Kubernetes chart or all-in-one image.
© 2026 Frameleaf Inc. All rights reserved.
Frameleaf and the Frameleaf logo are Trademarks of Frameleaf Inc.