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.

Sign up for GitHub

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

Jump to bottom

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -779,8 +779,16 @@ Click the button below, to deploy to Vercel 👇

### Deploying - Option #3: Docker

Pull Image: `docker pull lissy93/web-check`
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Image: docker pull lissy93/web-check

I don't think this is necessary, as if the image isn't found locally, it'll be pulled automatically during the run command. The exception being, unless they user wants to use a different registry (like GHCR). But in this instance, running that pull command will just download it from DockerHub, same as in the run command.


Run `docker run -p 3000:3000 lissy93/web-check`, then open [`localhost:3000`](http://localhost:3000)

or:

Run `docker -d --name webcheck -p 3000:3000 --restart=always lissy93/web-check`, then open [`localhost:3000`](http://localhost:3000)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to this. Or maybe a docker-compose.yml would be more suitable, as that's what most people are going to use to deploy, and it gets a bit hard to read with many docker flags.


This command sets up a detached container, gives it a name (webcheck), and configures it to auto-restart, enabling continuous operation in your environment for OSINT searches.

<details>
<summary>Docker Options</summary>

Expand Down