Skip to content

jorgegomzar/ntfy.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ntfy.nvim

This Neovim plugin will print NTFY messages from your subscribed topics inside Neovim.

Here is a quick demo!

Demo video

Installation & configuration

Lazy

{
  "jorgegomzar/ntfy.nvim",
  opts = {
    subscribe_on_init = true,  -- default: true
    host = "ntfy.self_hosted.com",  -- default: ntfy.sh
    topics = {"nvim", "my_other_topic"}, -- default: {"nvim"} 
    port = 80,  -- default: 443
    username = "my_user",  -- default: nil
    password = "my_password", -- default: nil
    since = nil,  -- see: https://docs.ntfy.sh/subscribe/api/#fetch-cached-messages
  },
  dependencies = { "folke/noice.nvim" }
},

Also, you can add extension to Telescope if you want to:

require("telescope").load_extension("ntfy")

## Extra considerations

This plugin connects to the NTFY host SSE stream. If you are self hosting your own NTFY server make sure your proxy is correctly configured.

I had some struggles but found that this nginx configuration worked for me:

location / {
    proxy_pass http://127.0.0.1:4001;  # or wherever your ntfy server is running
    proxy_set_header Host $http_host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For "$http_x_forwarded_for, $realip_remote_addr";
    proxy_set_header Connection '';
    proxy_http_version 1.1;
    chunked_transfer_encoding off;
    proxy_buffering off;
    proxy_cache off;
}

TODOs

  • Update docs
  • Support sending ntfy messages

About

Subscribe to NTFY topics inside of Neovim

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published