Skip to content

Latest commit

 

History

History
98 lines (51 loc) · 2.36 KB

Usage.markdown

File metadata and controls

98 lines (51 loc) · 2.36 KB

Usage

nobbic ACTION [ARG...]

Nobbic offers an easy way to install and run NodeBB with one of PostgreSQL, MongoDB or Redis as a main database, or one of the first two as a main and Redis as a session database.

It also allows to create backups and restore from those backups.

Most of the actions require specifying APP_NAME as their first argument. APP_NAME is simply a name of your chosing for the NodeBB installation, e.g., "my-new-forum".

Following "actions" are implemented so far:

  • list

    Lists pods created with nobbic.

    Read more

  • build APP_NAME

    Builds pod with containers using options passed through environment variables.

    Read more

  • start APP_NAME

    Starts pod with its containers, building it first if it does not exist yet.

    Read more

  • info APP_NAME

    Shows information about pod and its containers.

    Read more

  • bash APP_NAME

    Switches to the bash shell inside NodeBB's container.

    Read more

  • exec APP_NAME COMMAND [ARG...]

    Executes single command inside NodeBB's container's shell.

    Read more

  • backup APP_NAME [BACKUPS_DIR] [BACKUP_NAME]

    Creates backup directory with data from pod's containers.

    Read more

  • restore APP_NAME [BACKUPS_DIR] [BACKUP_NAME]

    Restores pod and containers with data from backup.

    Read more

  • upgrade APP_NAME

    Creates backup, recreates pod using options from environment variables.

    Read more

  • install APP_NAME

    Creates system's (OpenRC or SystemD) service file and tries to install it.

    Read more

  • tunnel APP_NAME

    Creates "tunnel" between port 80 and port used by NodeBB's pod.

    Read more

  • stop APP_NAME

    Stops the pod and its containers.

    Read more

  • remove APP_NAME

    Removes pod, its containers and their data.

    Read more

  • cleanup ["nodebb"|"node"|"repo"]

    Removes pods (if any are still existing) and container images for NodeBB or both NodeBB and Node.js. Or "repo" volumes with NodeBB repository and other data shared between pods.

    Read more