Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcoDaniels committed Sep 5, 2023
1 parent 7ae8b96 commit c091e57
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 3 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,30 @@
# Cockpit CMS Proxy

A simple proxy to fetch assets from [Cockpit CMS](https://getcockpit.com/).

---

Install [nix package manager](https://nixos.org/download.html) to manage dependencies.

Start a [nix shell](https://nixos.org/manual/nix/unstable/command-ref/nix-shell.html#options) with

```shell
nix-shell
```

Set the environment variables for your Cockpit CMS:

```shell
export COCKPIT_BASE_URL=https://example.com
export COCKPIT_API_TOKEN=1234
export ASSET_PATH_PATTERN=/images/pattern
export TARGET_HOST=localhost
export TARGET_PORT=8080
export PORT=8000
```

Run the proxy with the command:

```shell
startDev
```
3 changes: 0 additions & 3 deletions shell.nix
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,6 @@ in pkgs.mkShell {
buildInputs = [
pkgs.nodejs-18_x
pkgs.elmPackages.elm
pkgs.elmPackages.elm-format
pkgs.elmPackages.elm-test
pkgs.elm2nix

startDev
];
Expand Down

0 comments on commit c091e57

Please sign in to comment.