Skip to content

Commit c091e57

Browse files
committed
Update readme
1 parent 7ae8b96 commit c091e57

File tree

2 files changed

+27
-3
lines changed

2 files changed

+27
-3
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,30 @@
11
# Cockpit CMS Proxy
22

33
A simple proxy to fetch assets from [Cockpit CMS](https://getcockpit.com/).
4+
5+
---
6+
7+
Install [nix package manager](https://nixos.org/download.html) to manage dependencies.
8+
9+
Start a [nix shell](https://nixos.org/manual/nix/unstable/command-ref/nix-shell.html#options) with
10+
11+
```shell
12+
nix-shell
13+
```
14+
15+
Set the environment variables for your Cockpit CMS:
16+
17+
```shell
18+
export COCKPIT_BASE_URL=https://example.com
19+
export COCKPIT_API_TOKEN=1234
20+
export ASSET_PATH_PATTERN=/images/pattern
21+
export TARGET_HOST=localhost
22+
export TARGET_PORT=8080
23+
export PORT=8000
24+
```
25+
26+
Run the proxy with the command:
27+
28+
```shell
29+
startDev
30+
```

shell.nix

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@ in pkgs.mkShell {
1616
buildInputs = [
1717
pkgs.nodejs-18_x
1818
pkgs.elmPackages.elm
19-
pkgs.elmPackages.elm-format
20-
pkgs.elmPackages.elm-test
21-
pkgs.elm2nix
2219

2320
startDev
2421
];

0 commit comments

Comments
 (0)