Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updating readme to make it easier to deploy using docker #117

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 22 additions & 8 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -779,17 +779,31 @@ Click the button below, to deploy to Vercel 👇

### Deploying - Option #3: Docker

Run `docker run -p 3000:3000 lissy93/web-check`, then open [`localhost:3000`](http://localhost:3000)
To deploy using Docker Compose, follow these steps:

<details>
<summary>Docker Options</summary>
1. Create a file named `docker-compose.yml` in your project directory and add the following content:

You can get the Docker image from:
- DockerHub: [`lissy93/web-check`](https://hub.docker.com/r/lissy93/web-check)
- GHCR: [`ghcr.io/lissy93/web-check`](https://github.com/Lissy93/web-check/pkgs/container/web-check)
- Or build the image yourself by cloning the repo and running `docker build -t web-check .`
```yaml
version: '3.9'

</details>
services:
web-check:
image: lissy93/web-check
ports:
- "3000:3000"
restart: always
container_name: web-check
```

2. Run the following command to start the service:

```sh
docker-compose up -d
```

3. Open [`localhost:3000`](http://localhost:3000) in your browser to access the service.

This configuration sets up a detached container, names it `web-check`, and configures it to auto-restart, enabling continuous operation in your environment for OSINT searches.

### Deploying - Option #4: From Source

Expand Down
7 changes: 4 additions & 3 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
version: '3.9'

services:
web-check:
container_name: Web-Check
image: lissy93/web-check
ports:
- 3000:3000
restart: unless-stopped
- "3000:3000"
restart: always
container_name: web-check