Federated Works

Themes, Addons, & Widgets

Federated Works is part of a decentralized social media network powered by Hubzilla.

Hubzilla and Neuhub Installation

Quick Copy & Paste Version for the Command Line

The full installation instructions are located in the install directory, or located online at:

Short Version: https://neuhub.org/help/admin/administrator_guide#Manual_Installation

Detailed Version: https://framagit.org/hubzilla/core/blob/master/install/INSTALL.txt

But after you install it a few dozen times, it just becomes easier to copy and paste the specific commands that you need.

Note: these commands are specifically tailored to work on cPanel systems, but you can adapt them to work on any other system. For example, on cPanel systems, your website is located in public_html. If your website is located in a different directory, then you would need to change this.

Pro Tip: Use Ctrl+Shift+V to paste the copied text in plain text format. This is useful if you are pasting it into a virtual terminal that expects plain text.

Prerequisites

An Empty Database (to install Hubzilla in)
Database Username and Password (assigned to that database)
The directory you install Hubzilla in must be empty (including hidden files).

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

cPanel Users: Do NOT delete the public_html directory on a cPanel server, since it has special permissions attached to it. Just delete the contents of the public_html folder.

Clone Hubzilla using the following commands:

git clone https://framagit.org/hubzilla/core.git public_html cd public_html mkdir -p "store/[data]/smarty3" chmod -R 755 store

Clone the Hubzilla addons, widgets, and themes repositories using the following commands:

util/add_addon_repo https://framagit.org/hubzilla/addons.git hzaddons util/add_widget_repo https://framagit.org/hubzilla/widgets.git hzwidgets util/add_theme_repo https://framagit.org/hubzilla/themes.git hzthemes

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

Finish Installation in Web Browser

Visit your domain name in a web browser and follow the instructions.

If you are using a cPanel-based server, set your PHP path to:

/usr/local/bin/php

Note: If your server has cPanel and AutoSSL enabled, after a few minutes, an SSL certificate should be installed automatically. Your SSL certificate needs to be installed before you can set up your website.

Cron every 10 minutes

cd /home/example/public_html; /usr/local/bin/php Zotlabs/Daemon/Master.php Cron > /dev/null 2>&1

Note: You will need to change the paths in the above cron job to work.

Install Addons

You can optionally install addons by command line to save you time.

Note: You cannot install these addons until you create the administrator account in the previous step. (Possible bug: Without an administrator account, it will say that it installs it, but it does not.)

These are popular addons:

util/addons install phpmailer

util/addons install pubcrawl

util/addons install statistics

util/addons install superblock

Some servers require phpmailer for email to function properly. Yours may not need this addon.

Some optional interface-related addons. Whether you install these depends on the purpose of the website and what features you want users to have.

This allows users to bookmark posts and links.

util/addons install bookmarker

This allows users to post using Markdown.

util/addons install mdpost

This enabled wikis for users.

util/addons install wiki

This enabled articles for users, which can be used for blogging.

util/addons install articles

Configuration

Some optional configurations. See Hidden Configs for more details.

This changes the default avatar to a round gray silhouette of a person. You can choose a different one if you want.

util/config system default_profile_photo circle_person

If you are allowing people to sign up, you can prevent them from registering certain channel names.

util/config system reserved_channels admin,administrator,forum,mod,moderator,official,owner,info

Note: If you plan on using these channel names, create the channels before executing this command.

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

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

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

Note: You cannot install the dev version and the main version at the same time.