General Discussion
  • Hi all,

    First, congratulations for this work, this is awesome. I'm currently trying to adapt it to one of my project, what do I have to write to respect the license. Is something like 'Powered by NodeBB - Copyright 2013' acceptable ?


  • Look at the current footer. I'd think something like that would be appropriate!

  • Hey @webaba,

    I'm not a lawyer, and I don't pretend to be one, but the license for NodeBB can be found here.

    Specifically, it states that you are free to modify and publish derivative works based on NodeBB, as long as the original copyright notice (the license) and authorship remain intact.

    If you are also publishing your project source, the NodeBB derivative must also be published, with the same GPLv3 license.

    Attribution itself in the forum is not covered by the license, and you may remove it as you see fit, although of course, attribution would be appreciated πŸ™‚

  • Just to make sure: can I edit source code of it? I have website and I want to make single login system for website and forum, so i will need to remove registration page and edit some other pages. The first line of license say "Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed." so I am not sure πŸ™‚ Definitely I would leave a footer with attribution.

  • as per the license you're free to modify the source code @dove

    when you're done, send us a message so we can add a link to your site on our blog! πŸ™‚

Suggested Topics

  • 3 Votes
    1 Posts

    (a development post by a contributor, not a team member πŸ™‚ )

    NodeBB currently works with docker... technically.
    I mean, the default image is fine if you set it up correctly - but that's a pretty big if and there wasn't any good documentation. The existing docker-compose file had some tiny pain points like:

    not exposing any ports by default it recommends setting up a reverse proxy like traefik, which can be a good idea and avoids a small docker security footgun (ports exposed by containers can bypass some firewall configurations, e.g. ufw) but also means that running docker compose up just starts up a container you can't connect to by default! You'll need to modify the config, whether you want to expose a port or set up Traefik... not setting up volumes I hope you like redoing all your configuration when updating the image! also, hope you installed some plugin for storing uploads remotely, since even they'll be gone when you delete and recreate the container you can also, again, edit it to resolve that issue not creating any database in the mongodb container using admin works, but is really not intuitive!

    And when I said the image was fine, I mean that it's acceptable, not that it's great. It always builds NodeBB before startup, installing and activating plugins in a way that will persist properly requires using arcane configuration options that are not mentioned in the docs (and it results in not being able to install or remove any plugins at runtime), and - again - setting up volumes is entirely up to the user.

    However, quite some time ago, @stevefan1999-personal made a pull request that addressed many of these issues, and over time came to address almost everything I mentioned here. And finally we're getting close to landing these changes, and some other small improvements, in NodeBB/NodeBB#12031

    So what will change?

    Running docker compose --profile mongo up is now all you need to start a working instance of NodeBB in a container. Initially it'll launch the web installer, with already populated database configuration, leaving you just to set up the NodeBB URL and admin account. Then just waiting a bit for setup to finish and you're done - NodeBB is running under port 4567. You can now use some reverse proxy on host, modify the compose file to expose it under port 80 or add a containerized reverse proxy and remove the default port binding. If you use the default compose file you'll notice that configuration and - more importantly - uploads are now mounted in .docker directory, so they'll persist when recreating the container There are some additional env variables that can affect the image startup behavior - e.g. you can now choose if NodeBB will run a build before starting.

    There's another nice change that you might've thought of if you saw the initial PR title - docker image size. And it's a fairly large difference. Some numbers:

    current image: 601MiB compressed/1.62GiB uncompressed original alpine PR: 315MiB compressed/986MiB uncompressed new PR (slim debian build): 211MiB compressed/674MiB uncompressed

    For reference, now the official MongoDB image is actually larger than NodeBB, and combined (even with redis added to the mix) they're still e.g. almost 2x smaller than Discourse slim image (747MiB compressed/2.02GiB uncompressed).
    And MongoDB is the largest of the supported databases - Postgres clocks at only 150MiB compressed and offers a 94MiB compressed alpine version, and Redis clocks in at 49MiB compressed for a debian image and just 15MiB for alpine.

    The result is that when running NodeBB with postgres the images will end up taking less than 1GB of disk space, basically half of what they do currently. All while offering much better user experience and configurability.

    And finally, Docker is graduating to being mentioned in official docs with NodeBB/docs#78 πŸ™‚

  • 0 Votes
    1 Posts

    I want to upload images to S3 or CF,but there isn't plugins I found,so I store the picture locally
    How do I set images to be cleared automatically, or how do I set posts to expire and be cleared,please help me..
    The follows are not working .

  • Copyright date

    General Discussion
    1 Votes
    1 Posts

    Hello. Just wanted to let the devs know that when you type in ./nodebb start the first line is this

    NodeBB v1.17.1 Copyright (C) 2013-2014 NodeBB Inc.

    And obviously the Copyright (C) 2013-2014 isn't correct. Doesn't bug me and i dont really care, just wanted to point out.

  • 0 Votes
    2 Posts

    You can put it wherever you want or you can remove it.

  • 0 Votes
    10 Posts

    if you're trying to embed nodebb on another site (i.e., the nodebb instance domain ISN'T your website's domain), you'll have to contend with CSP headers. just a heads up.

    if you have full control of the server on which your nodebb instance is hosted, you could set up a simple reverse proxy with nginx, point it to whatever port nodebb is listening on, and set the headers to something lax that way. config below.

    server { listen localhost:4000 ssl; server_name localhost; ssl_certificate /etc/nginx/ssl/localhost.crt; ssl_certificate_key /etc/nginx/ssl/localhost.key; ssl_protocols TLSv1 TLSv1.1 TLSv1.2; ssl_ciphers 'AES128+EECDH:AES128+EDH'; ssl_prefer_server_ciphers on; location /forum { proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; proxy_set_header Host $http_host; proxy_set_header X-NginX-Proxy true; client_max_body_size 100M; proxy_pass; proxy_redirect off; proxy_intercept_errors on; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade"; proxy_hide_header content-security-policy; proxy_hide_header x-frame-options; add_header content-security-policy "default-src * 'unsafe-eval' 'unsafe-inline' 'self' 'inline' 'http://*.*'"; } }

    you can append whatever domains you'd like to the 3rd to last line (the one that starts with add_header ...), though you shouldn't need to, since the * should whitelist all origins.

    you might ask, β€œwhat legitimate use would there be for this?!?”
    in my particular case, it's nice for local development β€” where your nodebb instance is already running elsewhere but you want to embed it in the site you're developing on your PC.