# Elgg-docker
Note: This documentation is not yet finalized

# What is Elgg?

![logo](https://elgg.org/images/elgg_small.png)

Elgg is an award-winning social networking engine, delivering the building blocks that enable businesses, schools, universities 
and associations to create their own fully-featured social networks and applications.

For more information and related for Elgg, please visit www.elgg.org.

# How to use this image

1.. Get Elgg:

```console
$ mkdir Elgg && cd Elgg
```

  Create file composer.json
```json
{
    "name": "your-account/elgg",
    "type": "project",
    "require": {
        "elgg/elgg": "2.0.0-beta.3"
    },
    "require-dev": {
        "phpunit/phpunit": "^4.7"
    },
    "minimum-stability": "dev",
    "prefer-stable": true,
    "scripts": {
        "post-install-cmd": "\\Elgg\\Composer\\PostInstall::execute",
        "post-update-cmd": "\\Elgg\\Composer\\PostUpdate::execute",
        "test": "phpunit"
  }
}
```

```console
$ composer self-update
$ composer global require "fxp/composer-asset-plugin:~1.0"
$ composer install
```

2.. Create file docker-compose.yml for running multi-container applications with docker-compose:

```yml
web:
  build: keviocastro/elgg-docker:2.0.0-beta.3
  ports:
    - "8000:80"
  links:
    - mysql
  volumes:
    - ~/path/to/Elgg/:/var/www/html/
  environment:
    MYSQL_USER: root
    MYSQL_PASS: root-pass
    ELGG_USERNAME: admin
    ELGG_PASSWORD: admin-pass
mysql:
  image: mysql:5.6  
  environment:
    MYSQL_DATABASE: elgg
    MYSQL_ROOT_PASSWORD: root-pass
```

```console
$ docker-composer up
```

3.. Install the Elgg:
```console
$ docker exec elggdocker_web_1 /elgg-docker/elgg-install.sh
```
Visit your Elgg site: http://localhost:8000

## Environment Variables

When you start the elgg-docker image, you can adjust the configuration of the elgg instance by passing one or 
more environment variables.

* `MYSQL_USER` The DB username to create
* `MYSQL_PASS` The DB password to set on the created user
* `ELGG_DB_HOST` The DB host Elgg will use
* `ELGG_DB_USER` The DB user Elgg will use
* `ELGG_DB_PASS` The DB password Elgg will use
* `ELGG_DB_PREFIX` Elgg's DB prefix 
* `ELGG_DB_NAME` The name of the DB Elgg will use
* `ELGG_SITE_NAME` Elgg's site name
* `ELGG_SITE_EMAIL` Elgg site email address 
* `ELGG_WWW_ROOT` Elgg's www_root (Don't change this unless you modify run.sh and the installation)
* `ELGG_DATA_ROOT` The data_root for Elgg (/media)
* `ELGG_DISPLAY_NAME` The display name for the admin user
* `ELGG_EMAIL` The email address for the admin user (must be a well-formed, though not necessarily value, address)
* `ELGG_USERNAME` The username of the admin user
* `ELGG_PASSWORD` The password for the admin user
* `ELGG_PATH` The location Elgg is installed (Don't change this unless you modify run.sh and the installation)
* `ELGG_SITE_ACCESS` The default site access