This page describes the installation of the Online Membership System (OMS) .
Linux operating system (Ubuntu is recommended), thus in case of MacOS/Windows it is suggested to virtualise
what are possible next steps after installation.
| Table of Contents | ||||
|---|---|---|---|---|
|
Linux
Prerequisites
- GIT
- docker and docker-compose (Versions tested: Docker 17.06.0-ce; Docker-compose 1.16.1)
Installation
Once you have installed the prerequisites, the following will install and run the system:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
git clone --recursive --branch dev https://github.com/AEGEE/oms-docker.git
cd oms-docker
bash ./oms.sh up |
Other OS
Prerequisites
Installation
Once you have installed the prerequisites, the following will install and run the system:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
git clone --recursive --branch dev https://github.com/AEGEE/oms-docker.git
cd oms-docker
vagrant up |
A first time setup can take quite a while. (~8 minutes + ~12 minutes if virtualised)
| Tip | ||
|---|---|---|
| ||
As the system is still in heavy development we are using the `dev` branch, eventually this should be changed to `master` |
Accessing the application
After running the system, you can navigate to it in your web browser. The URLs differ based on how you run it; however no matter how you decide to run it, it is suggested to edit the /etc/hosts file to add the entry: 192.168.168.168 appserver traefik.appserver portainer.appserver, to be able to use advanced features. (note: if you run through docker-only, you will add appserver traefik.appserver portainer.appserver in the same line that contains 127.0.0.1 localhost)
For using it, it becomes:
| Case | URL | ||
|---|---|---|---|
| Pure docker | http://localhost | ||
| Vagrant | http://localhost:8888 | ||
| Vagrant/Docker, applying the advice above | http://appserver, with the possibility of going to http://portainer.appserver or http://traefik.appserver |
Next steps to take
First steps - a basic tutorial
| Tip | ||
|---|---|---|
| ||
This is especially useful if you are somewhat new to programming! |
Usage tips
Did you just skip the tutorial? We really recommend having a look at it, but if you are sure here are some tips for more advanced users.
See the usage tips page for usage tips without a step-by-step guide.
Troubleshooting
In case you are running into problems during installation and running of the system.
See the troubleshooting page for troubleshooting.
Individual containers
For prerequisites and installation of individual containers, see their docker files, located in the (service)/docker folder in their respective repository.
Under the hood
Virtualbox is a utility that lets people creating virtual machines on your computer.
Vagrant is used as a tool to define VMs characteristics, that will be then run through Virtualbox - in other words, it is used so we can write a manifesto that defines the characteristics of a VM, and the VM generated has always the same characteristics. It is useful in this case to model the development VM just as if it was the server on which we will run the application.
Deployment
To aid deployment of the system there is a helper bash script `oms-docker/deploy.sh` that cleanly installs the newest version, as well as providing a way to keep the environment variables between versions. When deploying on fraktis.aegee.org (our public test server) this script should be used (located in `/srv/`).
...