Skip to content

Commit 891d3b9

Browse files
authored
docs: Update docker description in README (#32)
1 parent 3b300a8 commit 891d3b9

File tree

1 file changed

+23
-22
lines changed

1 file changed

+23
-22
lines changed

README.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,31 @@ Example Instances:
88

99
| Address | Expiry |
1010
|-----------------------------------|------------|
11-
| https://ark.jacobandersen.dev | 30 minutes |
1211
| https://api.schematic.cloud/ | 30 days |
1312

1413
## To Run
1514

16-
1. `git clone https://github.com/IntellectualSites/Arkitektonika.git`
17-
2. `cd Arkitektonika`
18-
3. `yarn install`
15+
### With Docker
1916

20-
#### Without Typescript transpiling
21-
22-
4. `yarn start`
17+
```bash
18+
docker pull intellectualsites/arkitektonika
19+
```
2320

24-
#### With Typescript transpiling (recommended)
21+
### From scratch
2522

26-
4. `yarn start:prod`
23+
```sh
24+
git clone https://github.com/IntellectualSites/Arkitektonika.git &&
25+
cd Arkitektonika &&
26+
yarn install
27+
```
2728

28-
## With Docker
29+
#### With Typescript transpiling (recommended)
2930

30-
---
31+
`yarn start:prod`
3132

32-
### Prebuilt images
33+
#### Without Typescript transpiling
3334

34-
Prebuilt image available at https://hub.docker.com/r/intellectualsites/arkitektonika
35+
`yarn start`
3536

3637
### Build image locally
3738

@@ -45,7 +46,7 @@ docker build -t intellectualsites/arkitektonika:<TAG> .
4546

4647
Example docker compose:
4748

48-
````yaml
49+
```yaml
4950
version: '3.8'
5051

5152
services:
@@ -57,7 +58,7 @@ services:
5758
- ./data:/app/data # Mount the data folder (containing config file, database and schematic storage)
5859
environment:
5960
- LOG_LEVEL=DEBUG # if debug logs should be printed to the console
60-
````
61+
```
6162
6263
`/app/data` is mounted to the host at `/data` as that folder contains persistent data.
6364

@@ -77,13 +78,13 @@ hours:
7778

7879
Or with a docker-compose configuration:
7980

80-
````
81+
```
8182
0 */12 * * * cd /srv/arkitektonika && docker-compose run --rm arkitektonika node app/launch.js --prune
82-
````
83+
```
8384

8485
## Configuration
8586

86-
````json
87+
```json
8788
{
8889
"port": 3000,
8990
"prune": 1800000,
@@ -95,7 +96,7 @@ Or with a docker-compose configuration:
9596
"delayMs": 500
9697
}
9798
}
98-
````
99+
```
99100

100101
| Config Key | Description |
101102
|--------------------|----------------------------------------------------------------------------------------------------------------------------|
@@ -109,14 +110,14 @@ Or with a docker-compose configuration:
109110

110111
## File structure:
111112

112-
````
113+
```
113114
data
114115
├── config.json
115116
├── database.db
116117
└── schemata
117118
├── fe65d7edc37149c47171962dc26a039b
118119
└── a98f299c5cf294e6555617e83226bcdd
119-
````
120+
```
120121
121122
`config.json` holds the user configuration data <br>
122123
`database.db` holds the required data for each schematic <br>
@@ -185,7 +186,7 @@ curl --location --request GET 'http://localhost:3000/download/db6186c8795740379d
185186
response:
186187
see **Check download headers** above.
187188

188-
On success, the file is sent as an attachment for download to the browser / requestor.
189+
On success, the file is sent as an attachment for download to the browser / requester.
189190

190191
### Check deletion headers
191192

0 commit comments

Comments
 (0)