NPMplus

https://github.com/zoeyvid/npmplus
Admin
NPMplus is an improved fork of Nginx Proxy Manager, offering enhanced features like HTTP/3, advanced...
Tokens:4,825
Snippets:67
Trust Score:9.3
License:AGPL-3.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Start NPMplus Container

Source: https://github.com/zoeyvid/npmplus/blob/develop/README.md

Command to initialize and run the NPMplus service in detached mode using Docker Compose.

```bash
docker compose up -d
```

--------------------------------

### Reset Password and MFA

Source: https://github.com/zoeyvid/npmplus/blob/develop/README.md

Use this command to reset a user's password or disable MFA for an SQLite-based installation.

```bash
docker exec -it npmplus password-reset.js USER_EMAIL [PASSWORD] [--disable-mfa]
```

--------------------------------

### Configure GeoIP2 Module in http_top.conf

Source: https://github.com/zoeyvid/npmplus/blob/develop/README.md

Define the GeoIP2 database path and map country codes to rules for whitelisting or blacklisting.

```yaml
geoip2 /data/goaccess/geoip/GeoLite2-Country.mmdb {
  auto_reload 60m;
  $geoip2_country_iso_code country iso_code;
}

# whitelist example, you can add as many country codes as you want, country code list: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#XY
#map $geoip2_country_iso_code $geoip2_country_rule {
#  default no;
#  AA yes;
#  XY yes;
#  '' yes; # if you want to allow IPs with unknown country codes, if you don't do this make sure to allow private IPs
#}

# blacklist example, you can add as many country codes as you want, country code list: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#XY
#map $geoip2_country_iso_code $geoip2_country_rule {
#  default yes;
#  AA no;
#  XY no;
#  '' no; # if you want to block IPs with unknown country codes, if you do this make sure to allow private IPs
#}

# uncomment if you block/don't allow IPs with unknown country codes
#geo $is_private_ip {
#  default no;
#  127.0.0.0/8 yes;
#  10.0.0.0/8 yes;
#  172.16.0.0/12 yes;
#  192.168.0.0/16 yes;
#  169.254.0.0/16 yes;
#  ::1/128 yes;
#  fc00::/7 yes;
#  fec0::/10 yes;
#}
```

--------------------------------

### Translation Directory Structure

Source: https://github.com/zoeyvid/npmplus/blob/develop/frontend/translations/README.md

The directory layout for language-specific UI strings and help documentation.

```text
translations/
├── lang-list.json      language names shown in the picker
├── ui/<code>.json      UI strings, `en.json` is the reference
└── help/<code>/*.md    help modal documents
```

--------------------------------

### Configure Crowdsec Acquisition for NPMplus

Source: https://github.com/zoeyvid/npmplus/blob/develop/README.md

Configuration file content for defining log file paths and appsec settings in Crowdsec.

```yaml
filenames:
  - /opt/npmplus/nginx/logs/*.log
labels:
  type: npmplus
---
listen_addr: 0.0.0.0:7422
appsec_config: crowdsecurity/appsec-default
name: appsec
source: appsec
labels:
  type: appsec
```

--------------------------------

### Certbot DNS Plugin Information File Structure

Source: https://github.com/zoeyvid/npmplus/blob/develop/backend/certbot/README.md

This JSON structure outlines the expected format for information files related to Certbot DNS plugins, including user-facing names, package names, credential file templates, and full plugin names.

```json
{
  "cloudflare": {
    "name": "Name displayed to the user",
    "package_name": "Package name in PyPi repo",
    "credentials": "Template of the credentials file",
    "full_plugin_name": "The full plugin name as used in the commandline with certbot, e.g. 'dns-njalla'"
  },
  ...
}
```

--------------------------------

### Sort Translation Files

Source: https://github.com/zoeyvid/npmplus/blob/develop/frontend/translations/README.md

Command to sort translation entries alphabetically.

```bash
./sort-locale.sh
```

--------------------------------

### Standard Certbot DNS Plugin Argument Structure

Source: https://github.com/zoeyvid/npmplus/blob/develop/backend/certbot/README.md

This is the standard command-line argument structure for Certbot DNS plugins that use a credentials file and specify propagation seconds.

```bash
--authenticator <plugin-name> --<plugin-name>-credentials <FILE> --<plugin-name>-propagation-seconds <number>
```

--------------------------------

### Check Missing Translations

Source: https://github.com/zoeyvid/npmplus/blob/develop/frontend/translations/README.md

Command to verify if a specific language code is missing translations.

```bash
./check-locale.sh [code]
```

--------------------------------

### Configure Anubis Policy Status Codes

Source: https://github.com/zoeyvid/npmplus/blob/develop/README.md

Define the status codes for challenge and deny states within the Anubis bot policy file.

```yaml
status_codes:
  CHALLENGE: 401
  DENY: 403
```

--------------------------------

### Apply Geoblocking to an Entire Host

Source: https://github.com/zoeyvid/npmplus/blob/develop/README.md

Apply the geoblocking rule to an entire host using the advanced tab, ensuring ACME challenges are allowed.

```yaml
# uncomment if you block/don't allow IPs with unknown country codes
#if ($is_private_ip = yes) { 
#  set $geoip2_country_rule yes; 
#}
if ($request_uri ~* "^/\.well-known/acme-challenge/") {
    set $geoip2_country_rule yes;
}
if ($geoip2_country_rule = no) { 
  return 444; # this rejects the connection, but you can also return 403 to tell the client that it was denied
} 
```

--------------------------------

### Define Nginx Upstream Block

Source: https://github.com/zoeyvid/npmplus/blob/develop/README.md

Use this configuration in http_top.conf or stream_top.conf to define a custom upstream group for load balancing.

```nginx
upstream cu_mybackend {
  zone cu_mybackend 128k;
  server 127.0.0.1:44 resolve;
  server 127.0.0.1:33 resolve;
  server 127.0.0.1:22 resolve;
  server 192.168.1.11:44 backup resolve;
}
```

--------------------------------

### Apply Geoblocking to a Specific Location

Source: https://github.com/zoeyvid/npmplus/blob/develop/README.md

Apply the geoblocking rule to a specific proxy location via the UI.

```yaml
# uncomment if you block/don't allow IPs with unknown country codes
#if ($is_private_ip = yes) { 
#  set $geoip2_country_rule yes; 
#} 
if ($geoip2_country_rule = no) { 
  return 444; # this rejects the connection, but you can also return 403 to tell the client that it was denied
} 
```

--------------------------------

### Configure external PHP-FPM for custom locations

Source: https://github.com/zoeyvid/npmplus/blob/develop/README.md

Use this Nginx location block to route PHP requests to an external PHP-FPM instance. Ensure the fastcgi_pass directive is updated with the correct socket or TCP address.

```nginx
location ~* [^/]\.php(?:$|/) {
  fastcgi_split_path_info ^(.*\.php)(/.*)$;
  try_files $fastcgi_script_name =404;
  fastcgi_pass ...; # set this to the address of your php-fpm (socket/tcp): https://nginx.org/en/docs/http/ngx_http_fastcgi_module.html#fastcgi_pass
}
```

--------------------------------

### Add Search Input to Table

Source: https://github.com/zoeyvid/npmplus/blob/develop/rootfs/usr/local/nginx/html/fancyindex-footer.html

Injects a search input field before the table to filter rows based on content. This script manipulates the DOM to add the input and attach an event listener for real-time filtering.

```javascript
var input = document.createElement("input"); input.id = "search"; input.type = "text"; input.placeholder = "Search here..."; document.querySelector("h1").after(input); var items = [].slice.call(document.querySelectorAll("#list tbody tr")); function filterItems(item, filter) { return !item.querySelector("td").textContent.trim().toLowerCase().includes(filter); } input.addEventListener("keyup", function () { items.forEach((item) => { item.hidden = false; }); items .filter((item) => filterItems(item, this.value.trim().toLowerCase())) .forEach((item) => { item.hidden = true; }); }); var tableDiv = document.createElement("div"); tableDiv.id = "tableDiv"; tableDiv.appendChild(document.querySelector("table")); document.getElementById("search").after(tableDiv);
```

--------------------------------

### Add Sorting Links to Table Headers

Source: https://github.com/zoeyvid/npmplus/blob/develop/rootfs/usr/local/nginx/html/fancyindex-footer.html

Enhances table headers by adding ascending sort indicators ('↑') and linking them to the existing sort functionality. This script iterates through table headers and modifies their structure.

```javascript
var headers = document.querySelectorAll("th"); headers.forEach((header) => { var links = header.querySelectorAll("a"); var ascendingLink = document.createElement("a"); ascendingLink.innerHTML = "&nbsp;↑&nbsp;"; ascendingLink.href = links[0].href; links[0].removeAttribute("href"); links[1].after(ascendingLink); });
```
Tokens:
Raw