If you need to deploy a classic archipelago with no/low modification, this is the good place to be.
However, if you want to custom your own archipelago use this repos https://github.com/data-players/deploy-archipelago-custom
However, if you want to use dockerhub images and Data Players personnalisation use https://github.com/data-players/archipelago-run-dockerhub
First make sur you get docker, docker-compose and git install on your linux server. Make sure you have an usable domain name, then create 3 sub-domain :
- middleware (Exemple : data.myDomain.com)
- frontend (Exemple : myDomain.com)
- authentification (Exemple login.myDomain.com)(optional if you use sso and want domain login with same root than your app)
Fork this project to get your own version and work on it.
You can test localy on your device by using the .dev docker-compose :
make start-local
Frontend on http://localhost:4000/ Middleware on http://localhost:3000/ Fuseki database on http://localhost:3030 (user: admin, password : admin) keycloak on http://localhost:8080 (Keycloak is a custom OIDC) You will get an error when creating some organisation :
index.js:209 Error: @semapps/geo-components : No access token in mapbox configuration
This is because MapBox Access Token is not define in the docker-compose file. This is not really a problem for local testing.
Some variables in the docker-compose file are default values. You need to replace them with yours to make it works.
- line 18 myEmail@myemail.fr
- line 39 MyJenaPassword
- line 64 MyJenaPassword
- line 65 https://data.myDomain.com/ (middleware URL)
- line 75 data.myDomain.com (middleware domain name)
- line 84 https://data.myDomain.com/ (middleware URL)
- line 85 MyMapBoxToken (obtain an access token : https://docs.mapbox.com/help/getting-started/access-tokens/)
- line 96 myDomain.com (Your domain name)
- line 104 myKeycloakPassword (To access OIDC admin page)
- line 106 https://login.myDomain.com/auth (Login URL)
- line 123 login.mydomain.com (Login domain name)
Of course you have to set up your domain name and sub domain name in your domain provider to make it works !
Launch your app by making a
make start-prod
If you need to force dockers to restart add : --force-recreate
Check in your favorite browser if it's work.
Before testing your new app, you must configurate your OIDC to autorize connexion from your domain name "data" (See environement variable line 67 above). Go to https://login.mydomain.com/auth and click on administration console. Connect with admin and "myKeycloakPassword". On the left panel, click on Clients, then semapps as client ID. If you scroll down, you must see a line "Valid Redirect URIs. Add your middleware address + "/" (exemple : https://data.mydomain.com/)
All customisation is based on the addOn directory.
If you want minor frontend change you can follow this step. Exemples : App Title, App Bar Color, Tab title and favicon.
Use the addOn directory in the repo to replace logo192/512.png, App.js, index.html and favicon.ico.
logo192.png : App Bar Logo, change it by your own logo (same name).
logo512.png : Ressource Logo, change it by your own (same name).
App.js : App Bar title, replace "MyArchipelago" line 23.
index.html : tab bar title, replace "MyArchipelago" line 18.
favicon.ico : tab bar icon, replace the file by your own (same name).
You can change the theme by owervriting customTheme.js, if you just need to change the App Bar color, replace css color "#28ccfb" line 8 by your selected color.
You can easily change other file and custom your archipelago from this directory. But if you begin to change everithing, maybe you need a custom deploy. More optimised.
Of course you can also change middleware files by adding them into the addOn/middleware directory. Same advise as frontend, rememeber that if you need more than simple changes, you probably need a custom archipelago.
You can perfectly use the custom keycloak installed in the docker-compose.
It is possible to use the les commun's OIDC, to doo it, you have to replace :
- line 59 semapps -> semapps-dp Then send an email to contact@data-players.com and give us your middleware domain name. Like in stape 3, we must authorize your connexion on our client.
You need to contact les communs if you need your own les commun's OIDC client. Ask in the rocket Chat for a "les communs" admins. https://chat.lescommuns.org/channel/accueil
you can use any OIDC server you want
https://www.npmjs.com/package/wait-on
https://semapps.org/docs/middleware/auth
Don't forget to restart
make start-prod```
make set-cron-prod
This will create a cron job to compact data every day at 4am.
use set-cron to make it localy.