How to Install Neuhub

The Neuhub Community Suite consists of Themes, Addons, and Widgets that work together to create an enhanced user experience. It is recommended that you install all three for the best experience.

Some web hosts or Managed Hubzilla providers will install Neuhub for you, so it might already be installed.

Administrators: scroll down to the section "for Administrators" for installation instructions.

Enabling Neuhub Themes

Neuhub must be installed by a Hubzilla Administrator who can install additional features.

If your Administrator has installed and enabled Neuhub, you may see additional options, such as new themes, in your channel's Display Settings.

To see if Neuhub themes are available:

1. Go to Settings.
   • In most themes, you would click on your avatar in the navbar and click on "Settings."
2. Click on Display Settings.
3. If there, you can select the theme of your choice.
4. Click on Submit to save your changes.

If the Neuhub themes are not listed, either the Administrator did not install them, or did not enable them for your use.

Installation

You will need to use the command line to install Neuhub.

Prerequisites

• Hubzilla 10.x or newer installed.
• Administrator account set up and configured.
• Command line access.

Once these are set up, you can continue to the next step.

Installing Neuhub via Command Line

Navigate to the directory Hubzilla is installed in. This varies by system.

Clone Neuhub using the following commands:

util/add_theme_repo https://framagit.org/federated-works/neuhub/hubzilla-themes.git neuhubthemes
util/add_addon_repo https://framagit.org/federated-works/neuhub/hubzilla-addons.git neuhubaddons
util/add_widget_repo https://framagit.org/federated-works/neuhub/hubzilla-widgets.git neuhubwidgets

This will add the themes, addons, and widgets to your Hubzilla Installation.

Changing the Default Avatar

You can optionally change the default avatar to a round gray silhouette of a person.

util/config system default_profile_photo circle_person

Additional avatar options can be viewed in the Hubzilla repository. You can also upload your own avatars to this directory and use those instead. As long as your uploaded files don't conflict with files in the repository, there will be no conflicts during updates.

Making a Theme the Default Theme

For pages that are not associated with a channel, Hubzilla will use the system theme you selected. This also becomes the default theme for any channel that has not selected a different theme.

1. Log into Hubzilla as the Administrator.
2. Visit the Admin Area.
   • In most themes, you would click on your avatar in the navbar and click on "Admin."
3. Click on Site in the sidebar menu.
4. Change the System theme to the desired theme.
5. Click on Submit to save your changes.

Activate the Theme for Community Members

This will allow your community members to select a different theme for their channel. They can only pick from the themes that have been activated by the administrator (as indicated by the checkmark next to the theme).

1. Log into Hubzilla as the Administrator.
2. Visit the Admin Area.
   • In most themes, you would click on your avatar in the navbar and click on "Admin."
3. Click on Themes in the sidebar menu.
4. Activate the desired theme(s) by clicking on the checkbox.
   • When enabled, it will show a check mark in a box.

If you do not want community members to use particular themes, you can uncheck those themes and they will become unavailable to new community members. Channels that already selected those themes will continue to do so, however if they switch to a different theme, they won't be able to switch back to a disabled theme. Channels that never selected a theme will always use the system theme.

K&T Host Restart Hubzilla

If you are on K&T Host, you will need to execute one additional command:

touch /system/action/hubzilla.restart

Development Branches

For testing purposes, we will pull the dev branches instead.

To install the dev branch, you will need to use some modified utilities found here:

https://framagit.org/federated-works/neuhub/snippets/-/tree/main/hubzilla/core/util

Step 1

Copy those to the util directory of your Hubzilla installation, and give them 755 permissions.

Step 2

Then execute the following commands to install the dev branch of Neuhub:

util/add_theme_repo_branch https://framagit.org/federated-works/neuhub/hubzilla-themes.git neuhubthemesdev dev
util/add_addon_repo_branch https://framagit.org/federated-works/neuhub/hubzilla-addons.git neuhubaddonsdev dev
util/add_widget_repo_branch https://framagit.org/federated-works/neuhub/hubzilla-widgets.git neuhubwidgetsdev dev

More Documentation

Some additional documentation related to installing Hubzilla on various systems.

• Hubzilla.hu Help
• Hubzilla DDEV Environment
• K&T Host - Install Hubzilla using SSH and Git
• K&T Host - Configure Hubzilla to Use SMTP Email Sending