Skip to content

Commit

Permalink
docs: update README with new configuration section
Browse files Browse the repository at this point in the history
  • Loading branch information
Björn Urban committed Feb 27, 2024
1 parent 1132a36 commit 1f6b1ad
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,19 @@ With these prerequisites met, you are now ready to proceed with the installation

## Environment Variables

The project requires setting certain environment variables for its operation:

- `PAPERLESS_BASE_URL`: The base URL for your Paperless instance.
- `PAPERLESS_TOKEN`: The API token used for authenticating against the Paperless API.

These should be defined in a `.env` file located at the root of your project directory.
The application requires setting environment variables for its configuration. Below is a table describing each environment variable, indicating whether it is required or optional, its default value (if any), and a brief description:

| Environment Variable | Required | Default Value | Description |
|----------------------------|----------|-----------------|--------------------------------------------------------------|
| `PAPERLESS_TOKEN` | Yes | None | The authentication token for accessing the Paperless API. |
| `PAPERLESS_BASE_URL` | Yes | None | The base URL for the Paperless API. |
| `OLLAMA_HOST` | No | "localhost" | The hostname where the Ollama service is running. |
| `OLLAMA_PORT` | No | "11434" | The port on which the Ollama service is accessible. |
| `OLLAMA_SECURE_ENDPOINT` | No | "false" | Whether to use HTTPS (`true`) or HTTP (`false`) for Ollama. |
| `OLLAMA_MODEL` | No | "llama2:13b" | The specific Ollama model to be used for processing. |

Make sure to set the required environment variables (`PAPERLESS_TOKEN` and `PAPERLESS_BASE_URL`) before running the application. Optional variables have default values and will use those defaults if not explicitly set.
For Development these should be defined in a `.env` file located at the root of your project directory.

## Docker Integration

Expand Down

0 comments on commit 1f6b1ad

Please sign in to comment.