Skip to content

Commit

Permalink
docs: sync .env file and format readme
Browse files Browse the repository at this point in the history
  • Loading branch information
allendema committed Nov 9, 2024
1 parent c6a41e5 commit 93d5d62
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 13 deletions.
18 changes: 11 additions & 7 deletions .env.example_hearchco
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
PUBLIC_UI_VERSION=dev
PUBLIC_URI=http://localhost:5173
# use local frontend with local backend
API_URI=http://localhost:3030 # server reachable
PUBLIC_API_URI=http://localhost:3030 # client reachable
# use local frontend with official backend (CORS is enabled for http://localhost:5173)
# API_URI=https://api.hearch.co
# PUBLIC_API_URI=https://api.hearch.co

# hearchco webui
PUBLIC_URI=https://hearchco.pi.local

API_URI=https://api.hearchco.pi.local
# allow self-signed https certificates (to searxng api)
NODE_TLS_REJECT_UNAUTHORIZED=0

# PUBLIC_API_URI is the webui which your devices should reach
# PUBLIC_API_URI must be allowed in cors (http headers) searxNG settings.yml
PUBLIC_API_URI=https://hearchco.pi.local
8 changes: 8 additions & 0 deletions .env.example_upstream
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
PUBLIC_UI_VERSION=dev
PUBLIC_URI=http://localhost:5173
# use local frontend with local backend
API_URI=http://localhost:8080 # server reachable
PUBLIC_API_URI=http://localhost:8080 # client reachable
# use local frontend with official backend (CORS is enabled for http://localhost:5173)
# API_URI=https://api.hearch.co
# PUBLIC_API_URI=https://api.hearch.co
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,21 @@ make install

## Setup

## Edit `.env` file with your domain.
## Add HTTP Headers for your frontend domain to searxNG settings.yml and restart it.
- Edit `.env` file with your domain.
- Add HTTP Headers for your frontend domain to searxNG settings.yml and restart it.
In 'server' -> 'default\_http\_headers' section:
```yaml
Access-Control-Allow-Origin: "https://*.pi.local"
Access-Control-Allow-Methods: "GET, POST"
Access-Control-Allow-Methods: "GET"
Access-Control-Allow-Headers: "Content-Type, Authorization"
```
`make dev`
- `make dev`

then visit your domain/webui to search!
- then visit your domain/webui to search!

## TODO
- fix image previews
- copy search url
- systemd service
- use [bunJS](https://bun.sh/) instead of yarn/pnpm.
- use [bun](https://bun.sh/) instead of yarn/pnpm.

0 comments on commit 93d5d62

Please sign in to comment.