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

Update README.md, explain running container, specify node 16 #102

Merged
merged 2 commits into from
Oct 18, 2023
Merged

Update README.md, explain running container, specify node 16 #102

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e61d618
Update README.md, explain running container, specify node 16
b-rad15 Oct 17, 2023
d947a29
Drop --tty flag from container run instruction
maddymeows Oct 18, 2023
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
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,19 @@ An easy-to-use tool for building and sending Discord messages and embeds using w

Live instance is available at <https://discohook.app/>.

## Setup
## Running via Container

Requires Node.js 12 and the Yarn package manager installed
This application is setup to publish a container image to `ghcr.io/discohook/site:latest`. This image can be run with [podman](https://podman.io/), [docker](https://www.docker.com/), or another service compliant with the [OCI](https://opencontainers.org/). The image can be run from the command line with the following command or in the desktop guis ([podman desktop guide](https://podman-desktop.io/docs/working-with-containers/starting-a-container))
```sh
# Replace 'podman' with 'docker' if using that, the command is equivalent
# Add --rm if you want the container to be removed automatically after being stopped
# If necesary, change the second 3000 to change which port on the local computer the app is bound to
podman run -d -p 3000:3000 ghcr.io/discohook/site:latest
```

## Local build and run

Requires Node.js 16 and the Yarn package manager installed

```sh
# Install dependencies
Expand Down
Loading