Skip to content

Commit 01d9036

Browse files
committed
fix: update the readme documentation
1 parent d653a71 commit 01d9036

File tree

1 file changed

+37
-7
lines changed

1 file changed

+37
-7
lines changed

README.md

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,55 @@ metadata and outputs for posterior analysis.
1313
You can install DISK using Docker or [building from source](./building.md)
1414
We recommend to use `docker` to install DISK.
1515

16+
### Requeriments:
17+
18+
To install DISK you need to meet the following requirements:
19+
20+
- Docker
21+
- Docker Compose
22+
- Operating System: Linux, macOS, Windows
23+
- Architecture: x86_64
24+
- Memory: 2GB
25+
- CPU: 1 core
1626

1727
### Docker
1828

19-
Install DISK with docker
29+
Install DISK with docker.
30+
31+
This command will install DISK in your current directory.
32+
2033

2134
```bash
22-
docker-compose up -d
35+
$ docker-compose up -d
2336
```
2437

38+
Now, you can verify if DISK is running.
2539

26-
## Usage
40+
```bash
41+
$ docker-compose ps
42+
```
2743

28-
### Check the server
44+
You will see the following output:
2945

30-
Open http://localhost:8080/disk-server/vocabulary to check that the local repository server is working fine. It might take a little while to open it for the first time as it downloads vocabularies from the internet.
46+
```
47+
Name Command State Ports
48+
---------------------------------------------------------------------------------------------------
49+
core_backend_1 catalina.sh run Up 0.0.0.0:8080->8080/tcp,:::8080->8080/tcp
50+
core_endpoint_1 /docker-entrypoint.sh java ... Up 0.0.0.0:3030->3030/tcp,:::3030->3030/tcp
51+
core_frontend_1 nginx -g daemon off; Up 0.0.0.0:8000->80/tcp,:::8000->80/tcp
52+
core_wings_1 catalina.sh run Up 0.0.0.0:7080->8080/tcp,:::7080->8080/tcp
53+
```
3154

32-
### Check the client
55+
If the state is `Up`, the service are running.
56+
You z`can access the web interface at `http://localhost:8000`.
3357

34-
Open http://localhost:8000/index.html to access the Disk UI that connects with the local repository
58+
## Troubleshooting
59+
60+
### Check the server
61+
62+
Sometimes, the server is not responding. You can check if the server is running by running the following command:
63+
64+
Open http://localhost:8080/disk-server/vocabulary to check that the local repository server is working fine. It might take a little while to open it for the first time as it downloads vocabularies from the internet.
3565

3666

3767
## Documentation

0 commit comments

Comments
 (0)