This repository contains the custom IETF modules for Wiki.js, packaged into a docker container image.
Once on the server:
docker network create wikinet
docker run -d --name=wiki-update-companion -v /var/run/docker.sock:/var/run/docker.sock:ro --restart=unless-stopped -h wiki-update-companion --network=wikinet ghcr.io/ietf-tools/wiki-update-companion:latest
For each Wiki.js instance:
xyz123
values in the command below:docker run -d --name=xyz123 -e DB_HOST=xyz123 -e DB_PORT=5432 -e DB_PASS=xyz123 -e DB_USER=xyz123 -e DB_NAME=wiki -e UPGRADE_COMPANION_REF=xyz123 -h xyz123 -p 80:3000 -v /xyz123/mappings.json:/wiki/server/modules/authentication/ietf/mappings.json:ro --network=wikinet --restart=unless-stopped ghcr.io/ietf-tools/wiki:latest
--name=xyz123
-> Name of the instance, should be unique for each container, e.g. --name=wiki-ietf
-e DB_HOST=xyz123
-> Hostname / IP of the PostgreSQL database server. (if database is on the host, see Database on Localhost below.)-e DB_PORT=5432
-> Port of the PostgreSQL database server.-e DB_USER=xyz123
-> Username to connect to the PostgreSQL database server.-e DB_PASS=xyz123
-> Password to connect to the PostgreSQL database server.-e DB_NAME=wiki
-> Database name on the PostgreSQL server.-e UPGRADE_COMPANION_REF=xyz123
-> Name reference to this container for the upgrade tool. Should be identical to the container name entered above (e.g. -e UPGRADE_COMPANION_REF=wiki-ietf
).-h xyz123
-> Hostname of the container instance. Should be identical to the container name entered above (e.g. -h wiki-ietf
).-p 80:3000
-> Change 80
to the desired port to expose. The port should be unique for each container. Do not change the 3000
value, this is the internal container port!-v /xyz123/mappings.json:...
-> Path on the server (host) to the mappings.json file. This file will be mounted into the container.--network=wikinet
-> Name of the bridge network created earlier.xyz123
with the name of the container):
docker logs xyz123 -f
The output should include the line HTTP Server: [ RUNNING ]
Add the proper config to your reverse-proxy software (e.g. nginx / apache) to point each domain to the correct port you exposed above.
If this is a new Wiki.js instance, complete the setup by loading the domain name in your browser.
Note that you cannot use localhost
or 127.0.0.1
as the DB_HOST
value to communicate to a PostgreSQL server installed on the host itself, as localhost refers to the container itself, not the host. You must instead add the following to the docker run command (note that there's nothing to replace in the command below, host-gateway
is a special docker keyword!):
--add-host=host.docker.internal:host-gateway
This will add a DNS entry in the container that automatically points to the Docker host IP address. You can then specify host.docker.internal
as the host for the DB_HOST
parameter.
Note
Themappings.json
provided in this repository is only an example and should be modified to match the target instance use case.
mappings.json
have been added under Groups. Missing groups are automatically created during initialization.Still under Groups, add the necessary page rules / permissions for all groups.
Note that groups must NOT be renamed. They must match exactly as they are in
mappings.json
.
Copy the whole ietf
folder under the path server/modules/authentication/
of your wiki.js instance.
The mapping between IETF datatracker roles and wiki.js groups can be specified in the mappings.json
file.
The format of the file is the following:
{
"defaults": Array of Strings,
"groups": Array of Strings,
"mappings": Object
}
defaults
contains the list of the groups that will be auto-added to any authenticated users, e.g.:
{
"defaults": ["members", "users"],
"groups": [],
"mappings": {
...
}
}
groups
contains the list of the groups that will be automatically created if they don't already exist on initialization:
{
"defaults": [],
"groups": ["iesg", "ietf-chairs"],
"mappings": {
...
}
}
mappings
has the following format:
{
"defaults": ...
"groups": ...
"mappings": {
"roles": {
"groupname_1": Array of Arrays,
"groupname_2": Array of Arrays,
"groupname_3": Array of Arrays,
...
},
"dots": {
"groupname_4": Array of Strings,
...
}
}
}
Any element of an array groupname
in the roles
section is a tuple [oidcRole, oidcGroup, ... ]
(as returned by the datatracker OIDC user-info API) that will match the groupname
wiki.js group, e.g.:
...
"mappings": {
"roles": {
"admins": [
[
"ad",
"iesg",
...
],
[
"chair",
"ietf",
...
],
],
"iesg": [
[
"ad",
"iesg"m
...
],
[
"execdir",
"ietf",
...
]
],
...
}
...
}
By using wildcards *
you can omit any tuple element, e.g.:
"mappings": {
"roles": {
"chairs": [
[
"chair",
"*",
...
]
],
"iesg-users": [
[
"*",
"iesg",
...
]
],
...
}
...
}
Any element of an array groupname
in the mappings dots
section is an array of strings [dot1, dot2, ... ]
(as returned by the datatracker OIDC user-info API) that will match the groupname
wiki.js group, e.g.:
"mappings": {
...
"dots": {
"chairs": [ "llc", ... ],
...
}
...
}
Any change to the mappings file requires a restart of the container while in dev mode.
This rendering module ensures that any references to RFC's or Internet Drafts are automatically linked to their corresponding Datatracker page.
This module should be enabled by default under the Administration Area > Rendering > HTML
docker-compose up
http://HOST:PORT
(default PORT
is 1926)mappings.json
npm install
npm run test
To release a new docker image, go to the Actions tab, select the Build and Release workflow and click Run workflow.