Commit e3f96e79 authored by William Hill's avatar William Hill
Browse files

added placeholder brackets

parent 3eeb84b9

docs/_docs/compose/quick-start.md

+5 −5
Original line number Diff line number Diff line
@@ -29,7 +29,7 @@ Next, create an empty directory to store the configuration for the deployment an 
the `ESGF_CONFIG` environment variable to point to it:



```sh

export ESGF_CONFIG=/path/to/config/directory

export ESGF_CONFIG=</path/to/config/directory>

mkdir -p $ESGF_CONFIG

```
@@ -39,8 +39,8 @@ required: 


```sh

cat > "$ESGF_CONFIG/environment" <<EOF

ESGF_HOSTNAME=local.esgf.org

ESGF_DATA=/path/to/data/directory

ESGF_HOSTNAME=<local.esgf.org>

ESGF_DATA=</path/to/data/directory>

EOF

```
@@ -101,7 +101,7 @@ Docker Compose: 
This will pull all the images from Docker Hub (unless they are already available

locally) and launch the containers in order.



Once all the containers are running normally, navigate to `https://$ESGF_HOSTNAME`

Once all the containers are running normally, navigate to `https://[$ESGF_HOSTNAME]`

in a browser and you should see the CoG interface. You can view the container

logs using commands of the form:
@@ -111,7 +111,7 @@ logs using commands of the form: 


where the optional `-f` means "follow", as in `tail -f`.



Try to log in with the OpenID `https://$ESGF_HOSTNAME/esgf-idp/openid/rootAdmin`.

Try to log in with the OpenID `https://[$ESGF_HOSTNAME]/esgf-idp/openid/rootAdmin`.

To find the `rootAdmin` password that was randomly generated for you, run the

following command:

docs/_docs/compose/testing.md

+20 −20
Original line number Diff line number Diff line
@@ -18,35 +18,35 @@ In what follows, replace `my-node.esgf.org` with the specific hostname assigned 
The following procedure can be used to manually test an ESGF node installation using a browser.



* `CoG` home project:

	* <https://my-node.esgf.org/projects/testproject/>

	* <https://{my-node.esgf.org}/projects/testproject/>

	* Check you can login with the local credentials below, and with at least one other external openid:

		* openid=https://my-node.esgf.org/esgf-idp/openid/rootAdmin

		* openid=https://{my-node.esgf.org}/esgf-idp/openid/rootAdmin

		* password=<value from cat $ESGF_CONFIG/secrets/rootadmin-password>



* `Solr` admin interface:

	* <https://my-node.esgf.org/solr/#/>

	* <https://{my-node.esgf.org}/solr/#/>

	* Check you can perform a basic search.



* `ESGF search` API:

	* <http://my-node.esgf.org/esg-search/search>

	* <http://{my-node.esgf.org}/esg-search/search>



* `ESGF IdP`:

	* <https://my-node.esgf.org/esgf-idp/>

	* <https://{my-node.esgf.org}/esgf-idp/>



* `ESGF ORP`:

	* <https://my-node.esgf.org/esg-orp/>

	* <https://{my-node.esgf.org}/esg-orp/>

	* Check you can login with the credentials above.



* `TDS`:

	* <https://my-node.esgf.org/thredds> 

	* <https://{my-node.esgf.org}/thredds>

	* Check you can browse the catalogs, and download one file after logging in.



* `ESGF-Auth` web client:

	* <https://my-node.esgf.org/esgf-auth/home/>

	* <https://{my-node.esgf.org}/esgf-auth/home/>

	* Check you can login with the openid and password above, and with at least one other external openid.



* `SLCS`:

	* <https://my-node.esgf.org/esgf-slcs/admin/> 

	* <https://{my-node.esgf.org}/esgf-slcs/admin/>

	* Check you can log in as root administrator using:

		* username=rootAdmin

		* password=<value from cat $ESGF_CONFIG/secrets/rootadmin-password>