[FEAT] new env var and mount point: PLUGINS_PATH

Open Beginner friendly
#23 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
docker

Research direction

Review the repository documentation and container configuration, then compare them with the referenced Manyfold example Dockerfile. Document how Linuxserver users should configure PLUGINS_PATH and mount persistent storage, including the /config/plugins example. Done means the recommended setup is clear without changing application behavior.

Written by the indexing model from the issue text.

Description

enhancement no-issue-activity
Is this a new feature request?
  • I have searched the existing issues
Wanted change

Linuxserver images need a new volume mount for persistent plugin storage - most likely this is a documentation change.

Reason for change

I've added a new plugin system to Manyfold (coming in v0.146.0). In order to last between container updates, the plugins need to be stored somewhere persistent. I've added a PLUGINS_PATH environment variable which defaults to the app's plugins directory, but it needs persistent storage mounted at that location, which I've mentioned in our example dockerfile (see https://github.com/manyfold3d/manyfold/pull/6569).

Proposed code change

The app will work without persistent storage mounted, and should show a warning on the plugin screen if it's not writable, so nothing should break; however, I imagine you'll want to add how users should set this up in a linuxserver way in your docs. Normally I'd do a PR myself, but I don't want to make assumptions on what you want your users to do.

As an example, in our single-container "solo" image, I've preconfigured the path to /config/plugins, as there's already an SQLite database at /config and users will already have a volume mounted there that we can use.

Dominant language
Dockerfile
Stars
9
Forks
3
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Similar issues

More DevOps issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.