Skip to content

chore: update readme #20

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

Merged
merged 1 commit into from
Mar 14, 2023
Merged

chore: update readme #20

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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,16 @@ This Repository is used together with SOA based projects, consisting of microser

### → Purpose

Containing docker services in this repository can be shared across all microservices in one domain.
The purpose of this repository is to contain Docker services that can be shared across all microservices in one domain.

<br>

## 📑 Requirements
## 🚩 Requirements

* **macOS** Monterey or **Linux**
* **Docker** 20.10 or newer
- [How To Install and Use Docker on Ubuntu 22.04](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-22-04)
* **Cloned, configured and running** [docker-shared-services](https://github.com/wayofdev/docker-shared-services), to support system wide DNS, Routing and SSL support via Traefik.
* **Cloned, configured and running** [docker-shared-services](https://github.com/wayofdev/docker-shared-services), to support system-wide DNS, Routing and SSL support via Traefik.

<br>

Expand All @@ -42,7 +42,7 @@ Containing docker services in this repository can be shared across all microserv

### → Instructions

1. Download repository:
1. Clone repository:

```bash
$ git clone git@github.com:wayofdev/docker-project-services.git
Expand All @@ -59,9 +59,9 @@ Containing docker services in this repository can be shared across all microserv
$ make env
```

Edit created .env file, if it is needed. Probably you will want to change default domain.
Edit the created .env file if necessary. You may want to change the default domain.

3. (Optional) Enable docker-compose.override file to run extra services, like pg-admin and others:
3. (Optional) Enable the `docker-compose.override.yaml` file to run extra services, like pg-admin and others:
```bash
$ make override
```
Expand Down