update contributing guidelines and caddy configuration;
+6
-18
+2
-10
CONTRIBUTING.md
+2
-10
CONTRIBUTING.md
···
1
1
# Contributing to the project
2
2
3
-
You'll need to proxy requests from `*.smallweb.localhost:443` to `localhost:7777` to run the project locally. The easiest to achieve is to use the following caddyfile:
4
-
5
-
```sh
6
-
smallweb.localhost, *.smallweb.localhost {
7
-
reverse_proxy localhost:7777
8
-
}
9
-
```
10
-
11
-
You can follow the instructions from the [docs](https://www.smallweb.run/docs/hosting/local/) to find out how to install caddy locally.
3
+
You'll need to proxy requests from `https://*.smallweb.localhost:443` to `http://localhost:7777` to run the project locally. We'll use caddy to do that.
12
4
13
-
> [!WARNING] Make sure to trust the certificate generated by caddy by running the `caddy trust` command.
5
+
First, you'll need to install caddy. Then, make sure to add the caddy root certificate to your system's trust store by running `caddy trust`. Finally, use `caddy run` at the root of the project to start the reverse proxy.
14
6
15
7
If you're using MacOS, you'll also need to create the `/etc/resolver/localhost` file with the following content:
16
8
+1
-1
Caddyfile
+1
-1
Caddyfile
+3
-7
docker-compose.yml
+3
-7
docker-compose.yml
···
1
1
services:
2
2
smallweb:
3
3
image: ghcr.io/pomdtr/smallweb:latest
4
-
volumes:
5
-
- ./examples:/smallweb
6
-
caddy:
7
-
image: caddy:latest
8
4
ports:
9
-
- "80:80"
10
-
- "443:443"
5
+
- 7777:7777
6
+
- 2222:2222
11
7
volumes:
12
-
- ./Caddyfile:/etc/caddy/Caddyfile
8
+
- ./examples:/smallweb