Share NodeBB setup between Devices

[email protected]

Hello, I am working in the team on NodeBB project. I've already installed some plugins such as nodebb-plugin-session-sharing and nodebb-plugin-sso-oauth2-multiple. They require some setup for it. I want to share my current with my coworkers and I don't know how to do it, I'd be very thankful for any help.

Right now, there is a clonned github repo with one main branch. When I check the file changes, there are more than 5k. I am not sure if I pushed all of them, they would sync up my changes.

Therefore, what should I do?

[email protected]

Rp1 maybe you can use docker and share the image with the team

[email protected]

Ashutosh-Verma, good suggestion, however, I am not sure which exact image should I share? And if so, where data is saved?

[email protected]

Rp1 Are you famailiar woth Docker compose? I can maybe help with that.

[email protected]

Ashutosh-Verma , yeah, I know a little about it, what exactly do you want to do with it?

[email protected]

Rp1 This is my docker-compose.yaml file

services:
  nodebb:
    build: .
    restart: unless-stopped
    container_name: nodebb
    ports:
      - '4567:4567' # comment this out if you don't want to expose NodeBB to the host, or change the first number to any port you want
    volumes:
      - ./nodebb/nodebb-build:/usr/src/app/build
      - ./nodebb/nodebb-uploads:/usr/src/app/public/uploads
      - ./nodebb/nodebb-config:/opt/config
      - ./setup.json:/usr/src/app/setup.json

  postgres:
    image: postgres:17.5-alpine
    restart: unless-stopped
    environment:
      POSTGRES_USER: nodebb
      POSTGRES_PASSWORD: nodebb
      POSTGRES_DB: nodebb
    volumes:
      - ./postgres/postgres-data:/var/lib/postgresql/data

This is my Dockerfile

FROM ghcr.io/nodebb/nodebb:latest

# Install NodeBB plugins
# Add the plugins you want to use here

RUN npm install \
    nodebb-plugin-cards \
    nodebb-plugin-link-preview \
    nodebb-plugin-tenor-gif

# Expose the default NodeBB port
EXPOSE 4567

# The base image should already have the appropriate CMD/ENTRYPOINT

Just run docker compose up -d and you should have the forum up and the entire data should be in the directory itself.

You can then just share the directory itself with anybody and they will have the exact setup running.

NOTE: You'll have to manually create the file setup.json under root folder with docker-compose.yaml file BEFORE starting it ,You can get the file from Github here

If you get Permission errors (Most likely) run chown -R 1001:1001 ./nodebb ./setup.json

[email protected]

Ashutosh-Verma, but plugin settings will not be shared, am I right?

[email protected]

Rp1 Everything will be shared as is, Plugin settings, Database, app settings...everything