Server administration overview
Iodide is currently designed to be deployable on Heroku out of the box, using Github as an authentication provider. We are also steadily working on a docker-container based version of Iodide which should be suitable for use in other environments (e.g. Google Cloud Platform) using other authentication/identity providers, but this is not yet ready for public use.
This documentation is currently somewhat incomplete, help filling it out is welcome.
Important configuration variables
For the Iodide server to operate as expected, the following environment variables must be defined:
|DATABASE_URL||postgres://USER:PASSWORD...||Defines location of database, see dj-database-url documentation|
|GITHUB_CLIENT_ID||bdc0d336e6bdac44...||Github client id credential, provided when you register a github application|
|GITHUB_CLIENT_SECRET||9dd7e43338bc08b95ac7...||Github client secret credential, provided when you register github application|
|SECRET_KEY||q+50k8-no4ukn9pc25(i*=...||See django documentation|
|SERVER_URI||https://alpha.iodide.io/||Root URL of site|
Optional configuration variables
The following variables may be configured to add or change behaviour of the Iodide server:
|GA_TRACKING_ID||UA-1000005-1||If defined, google analytics (with the specified tracking id) will be used for pages loaded (users may opt-out by specifying Do Not Track)|
|EVAL_FRAME_ORIGIN||https://alpha.iodide.app/||If defined, refers to the domain that should be used to serve the eval frame|
|USE_OPENIDC_AUTH||1||If specified and true, use OpenIDC for authentication instead of GitHub|