Skip to content

Commit f39ad2c

Browse files
committed
add: more info in README
1 parent 41df74f commit f39ad2c

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# Hammer
22

3-
> easily execute commands on release
3+
> when all you have is a hammer, all deployments are nails
4+
5+
![GitHub Release](https://img.shields.io/github/v/release/matfire/hammer?style=for-the-badge)
6+
47

58
## Description
69

@@ -64,3 +67,20 @@ RestartSec=5
6467
[Install]
6568
WantedBy=multi-user.target
6669
```
70+
71+
The next step in deploying this solution is putting it behind a web proxy. This is done mainly so that github can send webhooks to the service because it requires an https domain.
72+
There are tons of solution from the most used (like Nginx and Apache), to more niche ones (like Traefik - at least for a simple reverse proxy), but the one I recommend for solutions like these is [caddy](https://caddyserver.com)
73+
74+
A simple Caddyfile for **hammer** might look like this:
75+
76+
```
77+
example.com {
78+
reverse_proxy :8080
79+
}
80+
```
81+
82+
## Extra
83+
84+
You can also change some configuration using environment variables, mainly those of [gin](https://gin-gonic.com/)
85+
86+
- PORT: to change the webservice's default port (otherwise, it will stay as 8080)

0 commit comments

Comments
 (0)