Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation for openeuropa platform #84

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update documentation for openeuropa platform #84

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
26 changes: 22 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Otherwise, ensure that in your site's `setting.php` file you have the connection
```
$databases["sparql_default"] = array(
'default' => array(
'prefix' => '',
'prefix' => '',
'host' => 'your-triple-store-host',
'port' => '8890',
'namespace' => 'Drupal\\Driver\\Database\\sparql',
Expand All @@ -78,6 +78,24 @@ $databases["sparql_default"] = array(
);
```

#### OpenEuropa site template setup

If you are working on a project using the OpenEuropa site template you should add the following to the runner.yml.dist file:

```
drupal:
additional_settings: |
$databases['sparql_default']['default'] = [
'prefix' => '',
'host' => getenv('DRUPAL_SPARQL_HOSTNAME'),
'port' => getenv('DRUPAL_SPARQL_PORT'),
'namespace' => 'Drupal\\Driver\\Database\\sparql',
'driver' => 'sparql',
];
```

This ensures that the config is in place before the installation and by doing so you no longer have to modify the settings.php manually.

## Usage

### OpenEuropa Content
Expand Down Expand Up @@ -122,10 +140,10 @@ Your test site will be available at `./build`.

### Using Docker Compose

Alternatively, you can build a development site using [Docker](https://www.docker.com/get-docker) and
Alternatively, you can build a development site using [Docker](https://www.docker.com/get-docker) and
[Docker Compose](https://docs.docker.com/compose/) with the provided configuration.

Docker provides the necessary services and tools such as a web server and a database server to get the site running,
Docker provides the necessary services and tools such as a web server and a database server to get the site running,
regardless of your local host configuration.

#### Requirements:
Expand All @@ -137,7 +155,7 @@ regardless of your local host configuration.

By default, Docker Compose reads two files, a `docker-compose.yml` and an optional `docker-compose.override.yml` file.
By convention, the `docker-compose.yml` contains your base configuration and it's provided by default.
The override file, as its name implies, can contain configuration overrides for existing services or entirely new
The override file, as its name implies, can contain configuration overrides for existing services or entirely new
services.
If a service is defined in both files, Docker Compose merges the configurations.

Expand Down