commit b3ea5100d33f6701539b28ef3ec021d1946401f7 Author: Matt Speer Date: Sat Dec 20 13:10:39 2025 -0600 initial commit diff --git a/README.MD b/README.MD new file mode 100644 index 0000000..fd82d4c --- /dev/null +++ b/README.MD @@ -0,0 +1,45 @@ +# Installation + +``` yaml +version: '3' +services: +  ntfy: +    image: binwiederhier/ntfy +    restart: always +    environment: +      NTFY_BASE_URL: https://ntfy.speerfam.net +      NTFY_CACHE_FILE: /var/lib/ntfy/cache.db +      NTFY_AUTH_FILE: /var/lib/ntfy/auth.db +      NTFY_AUTH_DEFAULT_ACCESS: deny-all +      NTFY_BEHIND_PROXY: true +      NTFY_ATTACHMENT_CACHE_DIR: /var/lib/ntfy/attachments +      NTFY_ENABLE_LOGIN: true +      NTFY_UPSTREAM_BASE_URL: https://ntfy.sh +      NTFY_WEB_PUSH_FILE: /var/lib/ntfy/webpush.db +      NTFY_WEB_PUSH_EMAIL_ADDRESS: +      TZ: America/Chicago +      PID: 1000 +      GID: 1000 +    volumes: +      - /home/mattspeer/docker/ntfy:/var/lib/ntfy +      - /home/mattspeer/docker/ntfy/cache:/var/cache/ntfy +      - /home/mattspeer/docker/ntfy/config:/etc/ntfy +    ports: +      - 8085:80 +    command: serve +``` + +# Users & Roles +``` bash +ntfy user list                     # Shows list of users (alias: 'ntfy access') +ntfy user add phil                 # Add regular user phil   +ntfy user add --role=admin phil    # Add admin user phil +ntfy user del phil                 # Delete user phil +ntfy user change-pass phil         # Change password for user phil +ntfy user change-role phil admin   # Make user phil an admin +ntfy user change-tier phil pro     # Change phil's tier to "pro" + +``` + +## Backup +All configuration in this deployment is contained in the compose yaml. Otherwise, it would be in `/etc/ntfy/server.yml` on the container's file system. \ No newline at end of file