jandieman
/
searxng-docker
mirror of https://github.com/searxng/searxng-docker.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README to use newer docker compose command (#205) 

* Update README to use newer docker compose command

* Update README to add note about docker < 3.6.0 and docker-compose

* Update the docker compose install url
This commit is contained in:
Nicolas Bonduel 2024-01-08 22:45:10 +01:00 committed by GitHub
parent 6813aff4d4
commit 3ec746a2b4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -12,7 +12,6 @@ Create a new SearXNG instance in five minutes using Docker
## How to use it ## How to use it
- [Install docker](https://docs.docker.com/install/) - [Install docker](https://docs.docker.com/install/)
- [Install docker-compose](https://docs.docker.com/compose/install/) (be sure that docker-compose version is at least 1.9.0)
- Get searxng-docker - Get searxng-docker
```sh ```sh
cd /usr/local cd /usr/local
@ -20,18 +19,24 @@ Create a new SearXNG instance in five minutes using Docker
cd searxng-docker cd searxng-docker
``` ```
- Edit the [.env](https://github.com/searxng/searxng-docker/blob/master/.env) file to set the hostname and an email - Edit the [.env](https://github.com/searxng/searxng-docker/blob/master/.env) file to set the hostname and an email
- Generate the secret key ```sed -i "s|ultrasecretkey|$(openssl rand -hex 32)|g" searxng/settings.yml``` - Generate the secret key `sed -i "s|ultrasecretkey|$(openssl rand -hex 32)|g" searxng/settings.yml`
- Edit the [searxng/settings.yml](https://github.com/searxng/searxng-docker/blob/master/searxng/settings.yml) file according to your need - Edit the [searxng/settings.yml](https://github.com/searxng/searxng-docker/blob/master/searxng/settings.yml) file according to your need
- Check everything is working: ```docker-compose up``` - Check everything is working: `docker compose up`
- Run SearXNG in the background: ```docker-compose up -d``` - Run SearXNG in the background: `docker compose up -d`
> [!WARNING]
> If you use an older version of docker desktop (`< 3.6.0`), you may have to install Docker Compose v1.
> Accordingly, you should modify the commands in this documentation to suit Docker Compose v1. For instance, change 'docker compose up' to 'docker-compose up'.
>
> [Install the docker-compose plugin](https://docs.docker.com/compose/install/#scenario-two-install-the-compose-plugin) (be sure that docker-compose version is at least 1.9.0)
## How to access the logs ## How to access the logs
To access the logs from all the containers use: `docker-compose logs -f`. To access the logs from all the containers use: `docker compose logs -f`.
To access the logs of one specific container: To access the logs of one specific container:
- Caddy: `docker-compose logs -f caddy` - Caddy: `docker compose logs -f caddy`
- SearXNG: `docker-compose logs -f searxng` - SearXNG: `docker compose logs -f searxng`
- Redis: `docker-compose logs -f redis` - Redis: `docker compose logs -f redis`
### Start SearXNG with systemd ### Start SearXNG with systemd