Skip to content
This repository was archived by the owner on Aug 18, 2020. It is now read-only.

Update README; Address #1. #2

Merged
merged 1 commit into from
Apr 25, 2016
Merged

Update README; Address #1. #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 contributing.md → CONTRIBUTING.md
View file
Open in desktop
File renamed without changes.
49 changes: 16 additions & 33 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,20 @@

[![Docker Stars](https://img.shields.io/docker/stars/islandora/claw-drupal.svg)](https://hub.docker.com/r/islandora/claw-drupal/)
[![Docker Pulls](https://img.shields.io/docker/pulls/islandora/claw-drupal.svg)](https://hub.docker.com/r/islandora/claw-drupal/)
[![Image Size](https://img.shields.io/imagelayers/image-size/islandora/claw-drupal/latest.svg)](https://imagelayers.io/?images=islandora/claw-drupal:latest)
[![Image Layers](https://img.shields.io/imagelayers/layers/islandora/claw-drupal/latest.svg)](https://imagelayers.io/?images=islandora/claw-drupal:latest)

### Introduction
## Introduction

Defines the Drupal Docker image.

Based on the [Base Docker Image](https://github.com/Islandora-CLAW/docker-base).

### Includes
## Includes

* Drupal 7
* Apache 2
* PHP 5.6

### Build Arguments
## Build Arguments

| Variable | Required | Default |
|----------------|----------|---------|
Expand All @@ -29,7 +27,7 @@ Based on the [Base Docker Image](https://github.com/Islandora-CLAW/docker-base).
docker build --build-arg "DRUPAL_VERSION=7.41" -t islandora/claw-drupal .
```

### Environment Variables
## Environment Variables

| Variable | Required | Default |
|---------------------------------|----------|-------------------------|
Expand All @@ -49,16 +47,11 @@ docker build --build-arg "DRUPAL_VERSION=7.41" -t islandora/claw-drupal .
| DRUPAL_SITE_DB_PASSWORD | yes | |
| DRUPAL_SITE_DB_REPLACE_EXISTING | no | no |

Please consult the
[parent image](https://github.com/Islandora-CLAW/docker-base).
Please consult the [parent image](https://github.com/Islandora-CLAW/docker-base).

**MYSQL_HOST & MYSQL_HOST_PORT:** If you link with the MariaDB container or
equivalent these variables are not required as it's provided by the linked
container.
**MYSQL_HOST & MYSQL_HOST_PORT:** If you link with the MariaDB container or equivalent these variables are not required as it's provided by the linked container.

**DRUPAL_SITE_DB_REPLACE:** If set to 'yes', the Drupal database will be
replaced on start-up; useful for debugging, but not recommend for production
sites.
**DRUPAL_SITE_DB_REPLACE:** If set to 'yes', the Drupal database will be replaced on start-up; useful for debugging, but not recommend for production sites.

**Example (foreground, random host port mapping, auto-remove, interactive shell):**
```bash
Expand All @@ -70,7 +63,7 @@ docker run --rm -ti -P \
islandora/claw-drupal ash
```

### Commands
## Commands

For convenience a number of commands are provided in the [commands](/commands)
folder.
Expand All @@ -79,14 +72,11 @@ folder.
|---------|-----------|----------|---------------------------------------------|
| build | | | Build this image with the default settings. |

### Notes
## Notes

This is **not** a stand alone image it needs a database image or external
database to connect to, you can either provide the required environment
variables to a working database, or you can link this container with
something equivalent.
This is **not** a stand alone image it needs a database image or external database to connect to, you can either provide the required environment variables to a working database, or you can link this container with something equivalent.

### Maintainers/Sponsors
## Maintainers/Sponsors

* UPEI
* discoverygarden inc.
Expand All @@ -103,21 +93,14 @@ something equivalent.
Current maintainers:

* [Nigel Banks](https://github.com/nigelgbanks)
* [Nick Ruest](https://github.com/ruebot)

### Development
## Development

If you would like to contribute, please get involved with the
[Islandora Fedora 4 Interest Group](https://github.com/Islandora/Islandora-Fedora4-Interest-Group).
We love to hear from you!
If you would like to contribute, please get involved by attending our weekly [Tech Call](https://github.com/Islandora-CLAW/CLAW/wiki). We love to hear from you!

If you would like to contribute code to the project, you need to be covered by
an Islandora Foundation
[Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_cla.pdf)
or
[Corporate Contributor Licencse Agreement](http://islandora.ca/sites/default/files/islandora_ccla.pdf).
Please see the [Contributors](http://islandora.ca/resources/contributors) pages
on Islandora.ca for more information.
If you would like to contribute code to the project, you need to be covered by an Islandora Foundation [Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_cla.pdf) or [Corporate Contributor Licencse Agreement](http://islandora.ca/sites/default/files/islandora_ccla.pdf). Please see the [Contributors](http://islandora.ca/resources/contributors) pages on Islandora.ca for more information.

### License
## License

[MIT](https://opensource.org/licenses/MIT)