[FEAT] new env var and mount point: PLUGINS_PATH
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
- Domain
- devops, documentation
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
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
copse-dev/agent-pane#2953 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
simonw/sqlite-utils#872 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 84/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
danielmiessler/LifeOS#2215 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
sympozium-ai/sympozium#627 ·