Skip to content
This repository was archived by the owner on Nov 21, 2019. It is now read-only.

Commit f94b3cf

Browse files
Try and make the README a bit clearer (#54)
* Try and make the README a bit clearer * Add link to dummy API config * Revert
1 parent 3964dcd commit f94b3cf

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

README.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,24 @@ Serve content read from a Libero API to the public.
88
Getting started
99
---------------
1010

11-
To run a website reading from two content services (`blog-articles` and `scholarly-articles`):
11+
1. Run `docker-compose down --volumes --remove-orphans && docker-compose up --build`.
1212

13-
1. Create `config/packages/content_page.yaml`:
13+
2. Open http://localhost:8080/articles/article1 to see the scholarly article `article1` in the `dev` environment.
14+
15+
### Configuration
16+
17+
The `dev` environment reads content from a [Libero dummy API](https://github.com/libero/dummy-api), using the configuration and data in [`.docker/api`](.docker/api).
18+
19+
Running in production
20+
---------------------
21+
22+
The application is not yet stable, but Docker images are published ([`liberoadmin/browser`](https://hub.docker.com/r/liberoadmin/browser)).
23+
24+
To run an image reading from two content services (`blog-articles` and `scholarly-articles`), you will need the following configuration:
25+
26+
- Set the `API_URI` environment variable to be the root of the Libero API.
27+
28+
- Create `config/packages/content_page.yaml` (either by extending the image or mounting a file):
1429

1530
```yaml
1631
content_page:
@@ -23,15 +38,9 @@ To run a website reading from two content services (`blog-articles` and `scholar
2338
service: 'scholarly-articles'
2439
```
2540
26-
2. Run `docker-compose -f docker-compose.yaml down --v && docker-compose -f docker-compose.yaml up --build`.
27-
28-
Note the `dev` environment is already preconfigured and can be accessed be running `docker-compose down -v && docker-compose up --build` instead.
29-
30-
3. Open http://localhost:8080/blog/foo to see the blog post `foo`.
31-
3241
Getting help
3342
------------
3443
3544
- Report a bug or request a feature on [GitHub](https://github.com/libero/libero/issues/new/choose).
36-
- Ask a question on the [Libero Community Slack](https://libero-community.slack.com/).
45+
- Ask a question on the [Libero Community Slack](https://libero.pub/join-slack).
3746
- Read the [code of conduct](https://libero.pub/code-of-conduct).

0 commit comments

Comments
 (0)