Skip to content

Commit

Permalink
Merge pull request #102 from b-rad15/patch-1
Browse files Browse the repository at this point in the history
Update README.md, explain running container, specify node 16
  • Loading branch information
maddymeows authored Oct 18, 2023
2 parents 6ce6d34 + d947a29 commit 57af9e7
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
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

0 comments on commit 57af9e7

Please sign in to comment.