Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
clusterzx committed Jan 6, 2025
2 parents c8213d6 + 25fd7f8 commit 1b0feef
Showing 1 changed file with 5 additions and 31 deletions.
36 changes: 5 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,37 +32,11 @@ An automated document analyzer for Paperless-ngx using OpenAI API and Ollama (Mi

## Installation

### You can use the easy way
```bash
docker run -d --name paperless-ai --network bridge -v paperless-ai_data:/app/data -p 3000:3000 --restart unless-stopped clusterzx/paperless-ai
```

### Or you can do it manually by yourself:

1. Clone the repository:
```bash
git clone https://github.com/clusterzx/paperless-ai.git
cd paperless-ai
npm install
```

2. Start the container:
```bash
docker-compose up -d
```

3. Open your browser and navigate to:
```
http://localhost:3000
```

4. Complete the setup by providing:
- Paperless-ngx API URL
- Paperless-ngx API Token
- Ollama API Data
OR
- OpenAI API Key
- Scan interval (default: every 30 minutes)
Visit the Wiki for installation:\
[Click here for Installation](https://github.com/clusterzx/paperless-ai/wiki/Installation)
-------------------------------------------
\
\

## How it Works

Expand Down

0 comments on commit 1b0feef

Please sign in to comment.