docker-rosariosis/README.md

86 lines
2.9 KiB
Markdown
Raw Normal View History

2016-06-29 22:06:44 +00:00
Docker RosarioSIS
=================
2016-06-29 22:06:44 +00:00
A Dockerfile that installs the latest [RosarioSIS](https://www.rosariosis.org/). This file pulls from the default branch, but can be easily modified to pull from any other available branch or tagged release.
## Installation
2016-06-29 22:06:44 +00:00
Minimum requirements: [Docker](https://www.docker.com/) & Git working.
You can pull the image from [DockerHub](https://hub.docker.com/r/rosariosis/rosariosis) or:
2020-06-12 12:59:58 +00:00
2016-06-29 22:06:44 +00:00
```bash
2019-05-19 17:00:04 +00:00
$ git clone https://gitlab.com/francoisjacquet/docker-rosariosis.git
2016-06-29 22:06:44 +00:00
$ cd docker-rosariosis
$ docker build -t rosariosis .
```
## Usage
2016-06-29 18:18:01 +00:00
RosarioSIS uses a PostgreSQL database:
2016-06-29 22:06:44 +00:00
```bash
$ docker run --name rosariosisdb -d postgres
$ docker run -e "ROSARIOSIS_ADMIN_EMAIL=admin@example.com" -e "PGHOST=rosariosisdb" -h `hostname -f` -d -p 80:80 --name rosariosis --link rosariosisdb:rosariosisdb rosariosis
```
Setup database:
```bash
$ docker exec -it rosariosisdb /bin/bash
# psql -h localhost -p 5432 -U postgres
postgres=# CREATE USER rosario WITH PASSWORD 'rosariopwd';
postgres=# CREATE DATABASE rosariosis WITH ENCODING 'UTF8' OWNER rosario;
postgres=# \q
```
2019-09-22 19:49:31 +00:00
Port 80 will be exposed, so you can visit `localhost/InstallDatabase.php` to get started. Default username and password: `admin`.
2015-05-18 04:51:46 +00:00
2019-09-22 19:49:31 +00:00
Note: a `docker-compose.yml` file is available.
## Environment Variables
2017-09-23 03:19:02 +00:00
The RosarioSIS image uses several environment variables which are easy to miss. While none of the variables are required, they may significantly aid you in using the image.
### PGHOST
Host of the postgres database.
2017-09-23 03:19:02 +00:00
### PGUSER
This optional environment variable is used in conjunction with PGPASSWORD to set a user and its password for the database.
2017-09-23 03:19:02 +00:00
### PGPASSWORD
This optional environment variable is used in conjunction with PGUSER to set a user and its password for the database.
2017-09-23 03:19:02 +00:00
### PGDATABASE
This optional environment variable can be used to define a different name for the database.
2017-09-23 03:19:02 +00:00
### PGPORT
This optional environment variable can be used to define a different port for the database.
2017-09-23 03:19:02 +00:00
### ROSARIOSIS_YEAR
This optional environment variable can be used to define the default school year in RosarioSIS settings.
2017-09-23 03:19:02 +00:00
### ROSARIOSIS_LANG
This optional environment variable is for RosarioSIS to show another language.
2017-09-23 03:19:02 +00:00
### ROSARIOSIS_VERSION
This optional environment variable is used to set the required version of RosarioSIS.
2017-09-23 03:19:02 +00:00
2015-05-18 04:51:46 +00:00
## SMTP
RosarioSIS will attempt to send mail via the host's port 25. In order for this to work you must set the hostname of the rosariosis container to that of `host` (or some other hostname that your can appear on a legal `FROM` line) and configure the host to accept SMTP from the container. For postfix this means adding the container IP addresses to `/etc/postfix/main.cf` as in:
2015-05-18 04:51:46 +00:00
```
2015-05-18 04:51:46 +00:00
mynetworks = 192.168.0.0/16 172.16.0.0/12 10.0.0.0/8 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128
```
2015-05-18 04:51:46 +00:00
2020-08-20 11:13:50 +00:00
Note: alternatively, you can use the [Email SMTP](https://www.rosariosis.org/plugins/email-smtp/) plugin for RosarioSIS.