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

Update README.md for authentication building block #520

Merged
merged 3 commits into from
Jul 29, 2020
Merged

Update README.md for authentication building block #520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3ee4be8
Update README.md
wenjzhu Jul 23, 2020
f895b84
Update CHANGELOG.md
wenjzhu Jul 24, 2020
9f34bfa
Merge branch 'develop' into task/519-auth-readme
sandeep-ps Jul 29, 2020
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Rokwire API Doc Dockerfile to integrate multiple OpenAPI specifications file. [#486](https://github.com/rokwire/rokwire-building-blocks-api/issues/486)
- Update Appconfig Building Block docker base image. [#515](https://github.com/rokwire/rokwire-building-blocks-api/issues/515)
- Update Authentication Building Block docker base image. [#517](https://github.com/rokwire/rokwire-building-blocks-api/issues/517)
- Update Authentication Building Block README [#519](https://github.com/rokwire/rokwire-building-blocks-api/issues/519)

### Removed
- rokwire.yaml file and deployment scripts that were not getting used. [#486](https://github.com/rokwire/rokwire-building-blocks-api/issues/486)
Expand Down
9 changes: 5 additions & 4 deletions authservice/readme.md → authservice/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,16 +50,17 @@ $ python auth_rest_service.py
```
### Run as a Docker Container

#### Docker Compose

You need to have Docker installed in your computer.

##### Run command
##### Build Docker Image and Run with Docker command

```
$ docker-compose up
docker build -f authservice/Dockerfile -t rokwire/authentication-building-block:latest .
docker run --name auth --rm --env-file=authservice/.env -e -p AUTH_URL_PREFIX=<url_auth_starting_with_slash> 5000:5000 rokwire/authentication-building-block:latest
```

Or update `docker-compose.yml` file and use `docker-compose up` to run

##### Docker Compose environment variable configuration

To run locally with Docker Compose, you will need to create a file called `.env`. See [here](https://docs.docker.com/compose/environment-variables/#the-env-file) for documentation on `.env` files. Here are the environment variables that need to be defined:
Expand Down