Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add notes on how to install addon packages in an extended container. #67

Closed
wants to merge 12 commits into from
Closed

Add notes on how to install addon packages in an extended container. #67

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
5c19fcc
Add notes on how to install addon packages in an extended container.
Rudd-O Sep 12, 2022
62c1d12
Better description of configure.zcml with example.
Rudd-O Sep 12, 2022
6bf5231
Update README.md
Rudd-O Sep 12, 2022
0494ad2
Update README.md
Rudd-O Sep 12, 2022
8c2fd0d
Create 67.bugfix
Rudd-O Oct 2, 2022
76e0238
Update README.md
Rudd-O Oct 2, 2022
3a00411
Update README.md
Rudd-O Oct 10, 2022
909a84a
Update README.md
Rudd-O Oct 10, 2022
d2a1f5f
Update README.md
Rudd-O Oct 10, 2022
a47053f
Update README.md
Rudd-O Oct 10, 2022
ce1e5e1
Update README.md
Rudd-O Oct 10, 2022
ede17ae
Update news/67.bugfix
Rudd-O Oct 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 22 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,13 +115,31 @@ FROM plone/plone-backend:6.0.0b2
RUN ./bin/pip install "relstorage==3.4.5" "psycopg2==2.9.3 --use-deprecated legacy-resolver"
```

Also create a `requirements.txt` file, with packages to be installed:
Make sure any Plone add-ons you are adding via `pip install` have their corresponding entry
points declared in `setup.py` — otherwise they will not be loaded by Plone:

```plain
pas.plugin.authomatic
```
Rudd-O marked this conversation as resolved.
Show resolved Hide resolved
...
Rudd-O marked this conversation as resolved.
Show resolved Hide resolved
entry_points="""
[z3c.autoinclude.plugin]
target = plone
""",
...
Rudd-O marked this conversation as resolved.
Show resolved Hide resolved

```

Also make sure that your add-ons do not use `zc3.autoinclude` in their `configure.zcml`
configuration file. Instead, list the packages to include in your add-on's
`configure.zcml`, explicitly:

```xml
...
Rudd-O marked this conversation as resolved.
Show resolved Hide resolved
<!-- -*- include dependencies / sync me with setup.py -*- -->
<include package="z3c.jbot" />
...
Rudd-O marked this conversation as resolved.
Show resolved Hide resolved
```

Build your new image
Now build your new image:

```shell
docker build . -t myproject:latest -f Dockerfile
Expand Down
1 change: 1 addition & 0 deletions news/67.bugfix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* Document notes on how to ensure addons load within the Plone backend container [Rudd-O]
Rudd-O marked this conversation as resolved.
Show resolved Hide resolved