Run through guide¶
## Fast tutorial
You will need:
A domain name <domain>
A tls keypair (<fullchain>, <privkey>)
A server with python (3.7 or newer) <python3>
Download the repository and run <python3> setup.py install, or install via pip: pip install arpoc
If successful you should now have the arpoc command.
Make yourself familiar with the basic interface with arpoc –help.
Create a configuration file arpoc –print-sample-config
Save the configuration file (preferable under /etc/arpoc/config.yml)
Create a default access control hierarchy using arpoc –print-sample-config
Save the access control hierarchy in a json file (defaultdir: /etc/arpoc/acl/)
### Edit the sample configuration
Fill in the right values for <keyfile>, <certfile>, <domainname>, <redirect> urls (path the openid connect providers will redirect the user to, with a leading slash) and the contacts field (at least on valid mail adress).
### Add an openid connect provider
You need the configuration url (should end with .well-known/openid/configuration, cut this part of, it is added automatically). You also need either:
A configuration token
A registration url and a registration token
Client ID and Client Secret
#### Configuration URL and Token:
Choose a key which arpoc uses internally for the provider.
Add both parameters to the config.yml under openid_providers -> <key> -> configuration_url openid_providers -> <key> -> configuration_token
#### Registration URL and registration token:
If you already registered your client and have a registration token add the configuration url, the registration url and the registration token under to the config.yml file under openid_providers -> <key> using the configuration_url, registration_url and registration_token.
#### Client ID and Client Secret
Add the configuration url to the config.yml. Call arpoc –add-provider <key> –client-id <client_id> –client-secret <client-secret>
### Add a service you want to protect.
You need the origin url, the proxy url and the key of an access control policy set (the key of an ac entity in the json file with type policy set).
Choose a key which arpoc will internally use for the service. Add the origin url and the proxy url (the path under which the service will be available with a leading slash) using the origin_URL and proxy_url keys under `services -> <service key> -> ` to the config.yml
Now you should be able to access the service.