Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Zoey <[email protected]>
  • Loading branch information
Zoey2936 authored Dec 31, 2024
1 parent 8e1fafa commit 1d83a26
Showing 1 changed file with 6 additions and 15 deletions.
21 changes: 6 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,9 @@ running at home or otherwise, including free TLS, without having to know too muc

- [Quick Setup](#quick-setup)

**Note: NO armv7, route53 and aws cloudfront ip ranges support.** <br>
**Note: Other Databases like MariaDB may work, but are unsupported.** <br>
**Note: watchtower does NOT update NPMplus, you need to do it yourself (it will only pull the image, but not update the container itself).** <br>
**Note: access.log/stream.log, logrotate and goaccess are NOT enabled by default bceuase of GDPR, you can enable them in the compose.yaml.** <br>
**Note: no support for the CF-Connecting-IPv6 header when using [Cloudflares Pseudo IPv4](https://developers.cloudflare.com/network/pseudo-ipv4)** <br>
**Note: Setups running inside LXC (running a Container in a Container makes no sense), Unraid (bad container implementation) or Synology (Port 80/443 blocked) are not recommended, if you want to report something please reproduce it somewhere else before reporting.** <br>

**Note: add `net.ipv4.ip_unprivileged_port_start=0` at the end of `/etc/sysctl.conf` to support PUID/PGID in network mode host.** <br>
**Note: Don't forget to open Port 80 (tcp) and 443 (tcp AND udp, http3/quic needs udp) in your firewall (because of network mode host, you also need to open this ports in ufw, if you use ufw).** <br>
**Note: If you don't use network mode host, which I don't recommend, don't forget to also expose port 443/udp (http3/quic needs udp) and to enable IPv6 in Docker see step 1 and 2 [here](https://github.com/nextcloud/all-in-one/blob/main/docker-ipv6-support.md).** <br>

**Note: no armv7, route53 and aws cloudfront ip ranges support.** <br>
**Note: other Databases like MariaDB/MySQL or PostgreSQL may work, but are unsupported and have no advantage over SQLite at all.** <br>
**Note: watchtower does NOT update NPMplus, you need to do it yourself (it will only pull the image, but will not redeploy the container itself).** <br>

## Project Goal
I created this project to fill a personal need to provide users with an easy way to accomplish reverse
Expand Down Expand Up @@ -200,7 +192,6 @@ All are welcome to create pull requests for this project, but this does not mean

# Please report Bugs first to this fork before reporting them to the upstream Repository
## Getting Help
1. Setups running inside LXC (running a Container in a Container makes no sense) or Unraid (bad container implementation) are not recommended, if you want to report something please reproduce it somewhere else before reporting.
2. [Support/Questions](https://github.com/ZoeyVid/NPMplus/discussions)
3. [Reddit](https://reddit.com/r/NPMplus)
4. [Bugs](https://github.com/ZoeyVid/NPMplus/issues)
1. [Support/Questions](https://github.com/ZoeyVid/NPMplus/discussions)
2. [Reddit](https://reddit.com/r/NPMplus)
3. [Bugs](https://github.com/ZoeyVid/NPMplus/issues)

0 comments on commit 1d83a26

Please sign in to comment.