Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
KTachibanaM committed Oct 20, 2024
1 parent 14ae517 commit d8ee0c1
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 16 deletions.
37 changes: 29 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,28 @@ Your filtered feed url will be this if you want to only include entries with ima
https://rss-lambda.xyz/rss?url=https%3A%2F%2Fnitter.example.net%2Ftwitter_handle%2Frss&op=filter_desc_cont_img
```

## Self-host
### (BETA) Filter a rss feed by only including entries with human image(s) in their descriptions
Your filtered feed url will be this if you want to only include entries with human image(s) in their descriptions
```
https://rss-lambda.xyz/rss_image_recog?url=https%3A%2F%2Fnitter.example.net%2Ftwitter_handle%2Frss&op=filter_desc_cont_img
```

### (BETA) Filter a rss feed by only including entries with dog image(s) in their descriptions
Your filtered feed url will be this if you want to only include entries with dog image(s) in their descriptions
```
https://rss-lambda.xyz/rss_image_recog?url=https%3A%2F%2Fnitter.example.net%2Ftwitter_handle%2Frss&op=filter_desc_cont_img_dog
```

### (BETA) Filter a rss feed by only including entries with cat image(s) in their descriptions
Your filtered feed url will be this if you want to only include entries with cat image(s) in their descriptions
```
https://rss-lambda.xyz/rss_image_recog?url=https%3A%2F%2Fnitter.example.net%2Ftwitter_handle%2Frss&op=filter_desc_cont_img_cat
```

## Self-hosting

You can use the following `docker-compose.yml` to run the program
```yaml
version: '3'
services:
app:
restart: always
Expand All @@ -63,18 +80,22 @@ services:
image: ghcr.io/sekai-soft/rss-lambda:latest
```
The program will be exposed at port 5000 and you can then use a reverse proxy like Nginx to expose it to the Internet
The web UI will be exposed at port 5000
The image recognition endpoints are not enabled by default. In order to enable them, you need to
Optionally you can specify the port that the program listens to. This is useful in scenarios such as [setting up a Tailscale sidecar](https://tailscale.com/blog/docker-tailscale-guide?utm_source=pocket_reader) where you need to have the program listen to port 80
1. Download the model. Create a new directory `blobs` under the docker compose root directory, download and run the [`download.sh`](https://github.com/sekai-soft/rss-lambda/blob/master/blobs/download.sh) file under that `blobs` directory.

2. Use the following `docker-compose.yml` file to run the program
```yaml
version: '3'
services:
app:
restart: always
ports:
- "5000:5000"
image: ghcr.io/sekai-soft/rss-lambda:latest
environment:
- PORT=80
# network_mode: service:tailscale-sidecar
volumes:
- ./blobs:/app/blobs
```

## Development
Expand Down
8 changes: 0 additions & 8 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,3 @@ services:
build: .
volumes:
- ./blobs:/app/blobs
ollama:
image: ollama/ollama:latest
volumes:
- ollama:/root/.ollama
ports:
- "11434:11434"
volumes:
ollama:

0 comments on commit d8ee0c1

Please sign in to comment.