OME Installation

Before you install

You will need the following:

  1. At least one OME peer node that has agreed to allow you to peer with them.

  2. Make sure that the peer can access your node

    1. IP address reachable from the outside by the peer.

    2. Port 119 (and 563) is unblocked for the peer.

    3. Port 119 on the host forwarded to port 1119, where Docker is listening.

Peering Configuration

Edit the file ./config.json. The contents of the file should look as follows:

{
    "organization": "ACME Org",
    "hostname": "nntp.ome.acme.org",
    "peers": [
        {
            "name": "WIDGET Org",
            "dns_name": "nntp.ome.widget.org",
            "incoming_ip": "172.21.0.1"
        }
    ],

    "nntp_user": {
        "username": "someusername",
        "password": "somepassword"
    },

    "nntp_debug_user": {
        "username": "debug_username",
        "password": "debug_password"
    },
    "cms_plugin": "server.plugins.qubes.plugin.QubesPlugin"
}

Variable

Value type

Comment

organization

Name of your organization

hostname

publicly resolvable hostname

peers

List of peers

At least one, preferably two

peers[i].name

Org name of the peer

peers[i].dns_name

hostname of the peer

peers[i].incoming_ip

IP address.[1]

The IP address of the peer you want to allow to connect.

nntp_user

The username/password that the FastAPI backend uses to connect to NNTP

nntp_user.username

username

nntp_user.password

password

nntp_debug_user

you can use this with a NNTP reader to access the NNTP directly

nntp_debug_user.username

debugging username

nntp_debug_user.password

debugging password

cms_plugin

python classpath for the plugin for your CMS

e.g. server.plugins.qubes.plugin.QubesPlugin

Backend

Plugin

Frontend

Integration into your platform