-
Notifications
You must be signed in to change notification settings - Fork 6
Site Integration Tasks
When you actually deploy docker-migrid for a production site you will want to not just reuse the existing ERDA, SIF or MiGrid templates included mainly for development instances but deploy it with your own branding and documentation to fit your site.
To get started you should try to decide which features you want to offer on the site and create the corresponding .env file with them enabled using the relevant ENABLE_X=True variable settings.
You can start out building with the EMULATE_X variables set to one of the existing sites to get something up and running, but before going live you should add your own page, snippets and documentation instead of the rather crude ones generated from any chosen templates.
The generated state/wwwpublic/index.html is used as the site start page with basic inforamtion and sign up / log in for users. If you chose
EMULATE_FLAVOR="erda"
EMULATE_FQDN="erda.dk"
SKIN_SUFFIX="ucph-science"
it will be a slightly modified version of the default ERDA start page (state/wwwpublic/index-erda.dk-ucph-science.html) with a number of ERDA and UCPH-specific references included. Various additional parts like About (about-erda.dk.html), FAQ (support-erda.dk.html), Terms of Use (terms-erda.dk.html), quick tips (tips-erda.dk.html), Status & News (status-news-erda.dk-ucph-science.html) and Cookie Policy (cookie-policy-ucph-science.pdf) are either linked or AJAX-loaded. You clearly don't want that for your own site, so you should either replace the index.html file completely or contact us to have your corresponding site template files integrated in the upstream migrid repo as similar -yoursite files and then use them with EMULATE_X="BLA-yoursite" variables to deploy them instead.
If you use the EMULATE_X variables you will also get the default look n' feel from the corresponding skin CSS files e.g. in mig/images/skin/erda-ucph-science/ . This includes various color schemes, layout and logos and again you'll want to provide and use your own skin to deliver your particular branding and appearance. It can either be done by replacing the skin in the deployment or by contacting us about integrating it in the migrid repo for deployment from there.
The migrid user pages reuse the contents of some of the above page snippets to deliver the actual About and Support popup contents as well as the Quick Tips fold-out on the user Home page. So even if you decide to create and use your own dedicated index.html, you likely still want to provide your own custom version of those snippets as well. You can replace the files mentioned above in your deployment or adjust the state/wwwpublic/*-snippet.html symlinks to point to your own version.
Sites can deliver status and news items through the colored status icon next to the About and Support buttons at the bottom right of user pages. Again this has some overlap with the general Status & News page linked on the start page, since both AJAX load their data from the optional state/wwwpublic/status-events.json file or symlink. Example status events json files can be found in the migrid-ucph-sites repo with a very simple one in https://github.com/ucphhpc/migrid-ucph-sites/blob/main/state/wwwpublic/basic-status.json . If saved or symlniked into place as state/wwwpublic/status-events.json it will be used to dynamically color the status icon and populate the attached popup window.