strog/ntfy-freebsd-server
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Formatting updates

Browse Source
This commit is contained in:
Dale Shrauger
2025-05-31 21:16:44 -05:00
parent 6376321c9d
commit 0403f6a3e2
1 changed files with 6 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -20,25 +20,17 @@ I built ntfy server on FreeBSD manually and have been testing it. I decided if I
### Build: ### Build:
sudo sh ./install_ntfy_server.sh `sudo sh ./install_ntfy_server.sh`
### Configure: ### Configure:
Edit your server.yml in /usr/local/etc/ntfy/ to set your hostname, listening Edit your server.yml in /usr/local/etc/ntfy/ to set your hostname, listening IP/port, and any other desired settings.
IP/port, and any other desired settings.
The nfty server service runs as a unprivileged user and must use a port The nfty server service runs as a unprivileged user and must use a port higher than 1024. Use a webserver or reverse proxy in front of ntfy to provide http/https access.
higher than 1024. Use a webserver or reverse proxy in front of ntfy to
provide http/https access.
Copy index.html to your webserver docs directory (e.g. Copy index.html to your webserver docs directory (e.g. https://ntfy.mydomain.com/docs/) to redirect to the online https://docs.ntfy.sh when a user clicks on the documentation button. Alternatively, you can mirror the online docs to your docs directory if you don't want to rely on theirs.
https://ntfy.mydomain.com/docs/) to redirect to the online https://docs.ntfy.sh
when a user clicks on the documentation button. Alternatively, you can mirror
the online docs to your docs directory if you don't want to rely on theirs.
Use 'sysrc ntfy_enable="YES"' or add 'ntfy_enable="YES"' to your /etc/rc.conf Use `sysrc ntfy_enable="YES"` or add `ntfy_enable="YES"` to your /etc/rc.conf or /etc/rc.conf.d/ntfy manually to enable the service. Use `service ntfy start` to start the service.
or /etc/rc.conf.d/ntfy manually to enable the service. Use 'service ntfy start'
to start the service.
**TODO**: **TODO**:
@ -48,5 +40,5 @@ to start the service.
- Testing client and config.  - Testing client and config. 
### License ### License
The project is dual licensed under the \[Apache License 2.0\](LICENSE) and the \[GPLv2 License\](LICENSE.GPLv2). The project is dual licensed under the [Apache License 2.0](LICENSE) and the [GPLv2 License](LICENSE.GPLv2).