Skip to content

Commit

Permalink
add to the instructions for setting up a local dev environment [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
briskt committed May 23, 2024
1 parent 4bf8403 commit c0caed4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ must be installed.

[Make](https://www.gnu.org/software/make) is optional but simplifies the build process.

[Vagrant](https://www.vagrantup.com) for Windows users.
[PHP](https://www.php.net) and [Composer](https://getcomposer.org) are optional, but at a minimum you need COMPOSER_CACHE_DIR set to a local directory for storing the PHP dependency cache. This must be set in your local development environment, not in the Docker container environment. For example, in your `~/.bashrc`, include `export COMPOSER_CACHE_DIR="$HOME/.composer"` and create an empty directory at `~/.composer`.

## Configuration
By default, configuration is read from environment variables. These are documented
Expand All @@ -34,9 +34,11 @@ will overwrite variables set in the execution environment.
## Local testing

1. `cp local.env.dist local.env` within project root and make adjustments as needed.
2. Add your github token to the `COMPOSER_AUTH` variable in the `local.env` file.
3. `make` or `docker-compose up -d` within the project root.
4. Visit http://localhost to see SSP running
2. `cp local.broker.env.dist local.broker.env` within project root and make adjustments as needed.
3. Add your github token to the `COMPOSER_AUTH` variable in the `local.env` file.
4. Create `localhost` aliases for `ssp-hub.local`, `ssp-idp1.local`, `ssp-idp2.local`, `ssp-idp3.local`, `ssp-sp1.local`, `ssp-sp2.local`, and `ssp-sp3.local`. This is typically done in `/etc/hosts`. _Example line: `127.0.0.1 ssp-hub.local ssp-idp1.local ssp-idp2.local ssp-idp3.local ssp-sp1.local ssp-sp2.local ssp-sp3.local`_
4. `make` or `docker-compose up -d` within the project root.
5. Visit http://ssp-hub.local to see SimpleSAMLphp

### Setup PhpStorm for remote debugging with Docker

Expand Down
6 changes: 1 addition & 5 deletions docs/material_tests.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@

# Testing the Material Module theme

[Make](https://www.gnu.org/software/make/), [Docker](https://www.docker.com/products/overview) and
[Docker Compose](https://docs.docker.com/compose/install/) are required.

## Setup

1. Setup `localhost` (or `192.168.62.54`, if using Vagrant) aliases for `ssp-hub.local`, `ssp-hub2.local`, `ssp-idp1.local`, `ssp-idp2.local`, `ssp-idp3.local`, `ssp-idp4.local`, `ssp-sp1.local` and `ssp-sp2.local`. This is typically done in `/etc/hosts`. _Example line: `0.0.0.0 ssp-hub.local ssp-idp1.local ssp-idp2.local ssp-idp4.local ssp-hub2.local ssp-idp3.local ssp-sp1.local ssp-sp2.local`_
1. Start test environment, i.e., `make` from the command line.
See [Local Testing](../README.md#local-testing) for instructions to set up your local development environment.

## Hub page

Expand Down

0 comments on commit c0caed4

Please sign in to comment.