Skip to content

Commit a1c3020

Browse files
committed
docs: redo readme for installation instructions
1 parent 58ce3f6 commit a1c3020

File tree

1 file changed

+16
-22
lines changed

1 file changed

+16
-22
lines changed

README.md

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -10,35 +10,29 @@ need. It also provides a proxy setup via nginx-proxy so that multiple projects
1010
can be run at the same time without the need for different ports.
1111

1212
This means docker configurations for each project only needs to worry about the
13-
the language and other tools it may need, as the databases and other services are
13+
language and other tools it may need, as the databases and other services are
1414
standardized in this project. Since most cloud providers provide managed versions
1515
of these services, you likely would not use a docker version of them in production.
1616

1717
## Docker
1818

1919
### Required: data source services
20-
1. Execute `git clone [email protected]:sourcetoad/DevopsToolKit.git devop-tools`
21-
2. `cd devop-tools`
22-
3. `cd ./docker/data-source-services/`
23-
4. Execute `./network-creation.sh`
24-
- If this fails, then manual configuration is necessary before compilation. Perform the following:
25-
1. `docker network create st-internal`
26-
5. Execute `docker-compose up --build`
27-
- If you're in a Windows environment, then perform the following if your build fails:
28-
1. Kill, and optionally disable, the `World Wide Web Publishing Service`.
29-
2. Run `set COMPOSE_CONVERT_WINDOWS_PATHS=1` in your CMD or PowerShell terminal.
30-
3. Redo step `5` or follow more detailed steps [here](https://github.com/docker/compose/issues/4303#issuecomment-379563170).
31-
6. Wait for the terminal to complete executing.
32-
7. You now have Sourcetoad data sources running and logging to the console.
3320

34-
### Optional: data source tools
35-
1. Optionally included is the following tools:
36-
* phpMyAdmin
37-
2. `cd devop-tools`
38-
3. `cd ./docker/data-source-tools/`
39-
4. Execute `docker-compose up --build`
40-
5. Wait for the terminal to complete executing.
41-
6. You now have Sourcetoad data source tools running.
21+
```bash
22+
git clone [email protected]:sourcetoad/DevopsToolKit.git devop-tools
23+
./devop-tools/docker/data-source-services/network-creation.sh
24+
cd ./devop-tools/docker/data-source-services && docker-compose up --build -d
25+
```
26+
27+
#### Specific Setup - Windows
28+
* Kill, and optionally disable, the `World Wide Web Publishing Service`
29+
* Run `set COMPOSE_CONVERT_WINDOWS_PATHS=1` in your CMD or PowerShell terminal
30+
* Optionally, [read](https://github.com/docker/compose/issues/4303#issuecomment-379563170) this bug report.
31+
32+
### Optional: Data Source Tools
33+
* Optionally included is the following tools:
34+
* phpMyAdmin
35+
* `cd ./devop-tools/docker/data-source-tools && docker-compose up --build -d`
4236

4337
## phpMyAdmin
4438
If the optional tools are launched, you can find phpMyAdmin at: localhost:8080

0 commit comments

Comments
 (0)