Skip to content

NodeBB Plugins

Discussion regarding NodeBB Plugin development.

1.8k Topics 15.0k Posts
Most Voted Plugins

Subcategories


  • Have a question about building a plugin? Ask here
    426 Topics
    2k Posts
    starkorebaS

    Hello, first of' thanks for the amazing work !
    For the context: I'm a junior developer from France, so excuse my english (and my limited understanding of everything lol). I was looking for a software alternative to build a forum RPG. I just installed NodeBB on Ubuntu 20 (Focal) working on WSL 2. I'm using redis and want to write plugin using typescript.

    It would be great to have a guide version of the Quickstart plugin in typescript !
    I know its possible to write plugin in typescript, the emoji plugin does that. But it would save me so much time to have a guide that explain the extra step we need to do in order of compiler and make it work on NodeBB.

    Here's my questions tho:

    Is it in the roadmap team of NodeBB to document how to write plugin in typescript? Did the team plan to write a typescript version of NodeBB?

    Although it would be great to have some more advanced example right in the documentation on how to do something and what are the step to make it work.
    Like here : https://community.nodebb.org/topic/16994/how-do-i-add-custom-user-fields-to-my-theme

    Like "if I want to add/ change something, I have to think of the scope of this features and what's need to be modify in other file to be working properly". Or at least, say it in the documentation a little bit more straightforward. So that beginner will understand that first sight. But I think examples are more worthy than tons of words.

    Is it possible for beginner to contribute on the documentation to make it more specific and understandable for beginners, or is it a documentation for more experienced developers and a choice of the team (and don't want to change that)?

    Is it because from a plugin to another, things might be working so differently that it's not worthy to do a more detailed documentation ?

    Because people might be wanted to write plugin over time, mutualisation of knowledge would be great, so that might simplified the process of each developer trying to write plugin have to go throw investigations to understand how NodeBB works before even start to develop the actual plugin.

    For example: How to interact with the database explain in this answer: https://community.nodebb.org/topic/17657/best-way-to-store-plugin-data-in-database-in-context-of-compatibility/2?_=1714543873650 for me this should be in the documentation.

    In conclusion, I feel like in general people agree that it's difficult to start writting plugin without investigate and dive in the structure file of the source code. I'm willing to help on that make it easier to really understand how NodeBB works for developer. So that anyone not familiar with the source code can start almost immediately customization. :emo:

  • Need a plugin developed? Ask here!
    222 Topics
    1k Posts
    barisB

    Plugin doesn't show usernames if they set their status to offline AFAIK

  • Broadcast message plugin

    1
    0 Votes
    1 Posts
    208 Views
    A

    Hi, Is there a plugin to broadcast a message to many users?

  • 0 Votes
    7 Posts
    430 Views
    oplik0O

    @sdetweil
    There is documentation on how templates work in the benchpress repository - that is the templating engine NodeBB uses: https://github.com/benchpressjs/benchpressjs/tree/master/docs

    There is a link to the engine in getting started development docs (https://docs.nodebb.org/development/) but I admit that it's not intuitive.

    The documentation for working with included helpers and client-side modules is basically nonexistent though, I mostly just look at other plugins (quickstart is a good reference for common use cases) and ultimately just look at the code. For the included setting types you can see it here: https://github.com/NodeBB/NodeBB/tree/master/public/src/modules/settings

  • 3 Votes
    1 Posts
    220 Views
    barisB

    Link Preview Image GitHub - NodeBB/nodebb-plugin-debug-hook: A plugin to see parameters passed to hooks in real time

    A plugin to see parameters passed to hooks in real time - NodeBB/nodebb-plugin-debug-hook

    favicon

    GitHub (github.com)

    Sometimes you need to see the result of some filter/action on a live/prod instance and it is not easy to add a console.log and restart.

    This plugin allows you to select a plugin hook and see the resulting data after all plugins are done executing their hooks.

    Here is a sample from running it against filter:search.query

    d0347032-02ff-4dcc-83a8-8bc039b4b297-image.png

    The output is updated automatically every time you trigger the hook.

  • filter new messages based on content, links

    7
    0 Votes
    7 Posts
    348 Views
    S

    @phenomlab thanks.. I have the plugin working..

    turn on moderation, set limit for reputation and number of posts. this will catch all those posts

    now, given a list of typical first user links our site, github, ...

    bypass moderation.. if no links or no links outside the list.

    otherwise into moderation as the default.

    now to build the admin for managing the list of 'good' urls
    now to learn ANOTHER language.. tpl.. ugh

  • Upload API

    1
    0 Votes
    1 Posts
    182 Views
    A

    Hi,
    How can i see the /api/post/upload interface?

    Thanks

  • Tenor GIF

    30
    0 Votes
    30 Posts
    3k Views
    crazycellsC

    works

  • WordPress SSO Plugin: Cannot save settings?

    2
    0 Votes
    2 Posts
    227 Views
    julianJ

    @CherryDT Nope, it is fixed now 😄 v2.2.2

    Link Preview Image Cannot save settings · Issue #12 · julianlam/nodebb-plugin-sso-wordpress

    Clicking the save icon in the admin settings for the plugin does nothing. In the developer console I see this error: app.js:146 error loading admin/plugins/sso-wordpress Error: Cannot find module './plugins/sso-wordpress' at eval (webpac...

    favicon

    GitHub (github.com)

  • 0 Votes
    6 Posts
    783 Views
    DownPWD

    Work on 2.4.4

  • Debugging in V2

    1
    0 Votes
    1 Posts
    174 Views
    E

    Hello Nodebb community,

    I am upgrading to V2 and one of the very first issues I am facing now is debugging of webpacked project. Is there an instruction for noob like me on how to set up my dev environment in more organized manner either in VS Code or Chrome devTools?

    I used to add my plugin folders as a workspace in Chrome devTools and automatic binding would allow me to debug the source files:
    old.PNG

    Sadly I am unable to do the same in V2 due to webpack source mapping not playing nice with Chrome. All I have came up with so far is enabling source-mapping by adding the following to webpack.xxx.js:

    devtool: 'source-map'

    This allows me to open inspection view of the source-mapped Nodebb project in Chrome devTools and view the scripts-client.js for debugging.
    new.PNG

    It is not as intuitive and simple as before so I am seeking you assistance.

    Thank you all in advance for your guidance.

  • Ignore user

    5
    0 Votes
    5 Posts
    399 Views
    T

    @crazycells said in Ignore user:

    @torn2 said in Ignore user:

    Installed that one but now forum loads very slow or get 503. Doesn't really have a compatibility version.

    that is possible, unfortunately, we are still behind at 1.19.X and it is working fine. But, there might be problems with the NodeBB v2...

    Please do not hesitate to open an issue on GH.

    Yea, it does not work with my version at all. Opened a ticket for review. Forum is crashed.

  • [nodebb-plugin-imgur] Imgur Plugin

    93
    6 Votes
    93 Posts
    52k Views
    julianJ

    @DownPW https://community.nodebb.org/post/88817

    Works fine on this site, at least?

  • Question and Answer Plugin - Permissions (2)

    1
    0 Votes
    1 Posts
    185 Views
    oci-userO

    Re: Question and Answer Plugin - Permissions

    I get no answer but today I discovered that should be possibile what I'm asking just how?

    I discovered on the Vivaldi forum user cannot set a question as answered.
    How I can do the same?

    I have installed the nodebb-plugin-question-and-answer and I want allow only moderator to set answers.

    How to do this? I need install a different plugin?
    I don't know what plugin use Vivaldi forum, looks same but with different graphics and seems allow they to allow only mod to select a best answer.

    Thanks, hope to get a reply this time 🙂

  • 0 Votes
    2 Posts
    296 Views
    cagatayC

    @shlomi pls read it

    Link Preview Image 2.0 Compatible Plugins

    We will release 2.0 I am going to keep a list of plugins here that are compatible already. If you have any plugins that are not in this list let us know and...

    favicon

    NodeBB Community (community.nodebb.org)

  • Discord Notification

    33
    0 Votes
    33 Posts
    2k Views
    Sampo2910S

    @gotwf

    I never really intended installing a GUI but gave it a try. For a lot of things it is much easier and I probably am one of those more comfortable with that 🙂

    Anyway, I had some help from @phenomlab and basically after removing the plugin I then installed using this method.

    npm install git+https://github.com/amargon/nodebb-plugin-discord-notification

    As I was told it may not be the best method however it worked and the plugin works fine now. As soon as the GitHub version is merged probably best to move back to 'traditional' install.

    Thank you for your reply 🙂

  • 0 Votes
    5 Posts
    396 Views
    julianJ

    You can set this value from ACP > Settings > EMail ("From Name")

  • This topic is deleted!

    2
    0 Votes
    2 Posts
    1 Views
  • What Does This Mean?

    4
    0 Votes
    4 Posts
    280 Views
    phenomlabP

    @julian is the same issue you recently fixed that was caused by regression.

  • Plugin Search Returns Nothing | v2.2.4

    4
    1 Votes
    4 Posts
    407 Views
    julianJ

    Hi all, there was a regression that I accidentally introduced into the package manager, which I have resolved now.

    Apologies for the blanked list!

  • 2.0 Compatible Plugins

    62
    5 Votes
    62 Posts
    9k Views
    crazycellsC

    @phenomlab said in 2.0 Compatible Plugins:

    @crazycells said in 2.0 Compatible Plugins:

    nodebb-plugin-embed

    Does anyone know if nodebb-plugin-embed works with NodeBB 2.1.0 ? All I get is a blank page. I'm using 3.0.19

    Thanks

    Unfortunately, we do not know yet 🙂 we are still behind at 1.19.X... when our developer team has time, we will start testing...

    But, the embed plugin page looks weird... It is not updated recently, but it also shows 3.0.18 as the latest version.

    Link Preview Image GitHub - TheWorms/nodebb-plugin-embed: Embed media and rich content in posts: YouTube, Vimeo, Twitch and more.

    Embed media and rich content in posts: YouTube, Vimeo, Twitch and more. - TheWorms/nodebb-plugin-embed

    favicon

    GitHub (github.com)

  • 0 Votes
    3 Posts
    414 Views
    omegaO

    @asadkhan890 said in Is there any nodebb plugin to remove meta data of posts?:

    garden

    That's a WordPress site afaict, I don't see any NodeBB installation - what have I missed?