diff --git a/README.md b/README.md index d079c5f..f608f0a 100644 --- a/README.md +++ b/README.md @@ -55,13 +55,13 @@ nano docker-compose.yml In order to run the app, the following configuration options must be set in the `.env` file or within `docker-compose.yml`. -| Name | Type | Default | Description | -| -------------- | ------ | -------------------------------------------- | ------------------------------------------------- | -| ICONIK_APP_ID | String | | The ID of the Iconik application token to use | -| ICONIK_TOKEN | String | | The token of the Iconik application token to use | -| NEW_STORAGE_ID | String | | The ID of the storage location to migrate to | -| REDIS_HOST\* | String | `redis` if production, otherwise `localhost` | The ip address or correction URL to use for Redis | -| REDIS_PORT\* | Number | 6379 | The port to use for Redis | +| Name | Type | Default | Description | +| -------------- | ------ | -------------------------------------------- | ---------------------------------------------------------------- | +| ICONIK_APP_ID | String | | The ID of the Iconik application token to use | +| ICONIK_TOKEN | String | | The token of the Iconik application token to use | +| NEW_STORAGE_ID | String | | The ID of the storage location to migrate to | +| REDIS_HOST\* | String | `redis` if production, otherwise `localhost` | The ip address or connection URL to use when connecting to Redis | +| REDIS_PORT\* | Number | 6379 | The port to use when connecting to Redis | _\*Only needed if specifically running locally_ @@ -74,8 +74,8 @@ The following table shows the various configurations options which can be set an | ICONIK_APP_ID | String | | The ID of the Iconik application token to use | | ICONIK_TOKEN | String | | The token of the Iconik application token to use | | NEW_STORAGE_ID | String | | The ID of the storage location to migrate to | -| REDIS_HOST\* | String | `redis` if production, otherwise `localhost` | The ip address or correction URL to use for Redis | -| REDIS_PORT\* | Number | 6379 | The port to use for Redis | +| REDIS_HOST\* | String | `redis` if production, otherwise `localhost` | The ip address or connection URL to use when connecting to Redis | +| REDIS_PORT\* | Number | 6379 | The port to use when connecting to Redis | | ADD_JOBS | Boolean | true | Set to true if jobs should automatically be generated and added to their respective queues, otherwise if false, only existing jobs will be processed | | CONCURRENCY | Number | 10 | The number of concurrent jobs to process per worker | | BULLMQ_PORT | Number | 3000 | The port to use for the dashboard |