Skip to content

Commit 95ea1dc

Browse files
committed
API and docker updates in readme
1 parent 29887a2 commit 95ea1dc

1 file changed

Lines changed: 14 additions & 2 deletions

File tree

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,12 +168,24 @@ curl -X 'POST' \
168168
169169
2. Create the `.env` file for shared environment information. An example environment file is included (`example.env`), which can be copied for this purpose. But make sure to change any security settings (username and passwords).
170170
171-
3. Build and start the services using Docker Compose:
171+
3. A directory containing RO-Crate profiles to replace the default RO-Crate profiles for validation may be provided. Note that this will need to contain all profile files, as the default profile data will not be used. An example of this is given in the `docker-compose-develop.yml` file, and described here:
172+
1. Store the profiles in a convenient directory, e.g.: `./local/rocrate_validator_profiles`
173+
2. Add a volume to the celery worker container for these, e.g.:
174+
```
175+
volumes:
176+
- ./local/rocrate_validator_profiles:/app/profiles:ro
177+
```
178+
3. Provide the `PROFILES_PATH` environment to the flask container (not the celery worker container) to match the internal path, e.g.:
179+
```
180+
- PROFILES_PATH=/app/profiles
181+
```
182+
183+
4. Build and start the services using Docker Compose:
172184
```bash
173185
docker compose up --build
174186
```
175187
176-
4. Set up the MinIO bucket
188+
5. Set up the MinIO bucket
177189
1. Open the MinIO web interface at `http://localhost:9000`.
178190
2. Log in with your MinIO credentials.
179191
3. Create a new bucket named `ro-crates`.

0 commit comments

Comments
 (0)