XenForo

https://github.com/xenforo-ltd/docs
Admin
XenForo is a comprehensive community forum software platform offering end-user management...
Tokens:204,447
Snippets:1,824
Trust Score:7
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Setup and run the documentation site locally

Source: https://github.com/xenforo-ltd/docs/blob/main/README.md

Commands to install dependencies, start the development server, build for production, and serve the production build locally. Requires Node.js 20.0 or higher.

```bash
# Install dependencies
pnpm install

# Start development server (http://localhost:3000)
pnpm start

# Build for production
pnpm build

# Serve production build locally
pnpm serve
```

--------------------------------

### Setup class with installStep1

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/lets-build-an-add-on.mdx

The Setup class with the first install step that adds a column to the xf_forum table.

```php
<?php

namespace Demo\Portal;

use XF\AddOn\AbstractSetup;
use XF\AddOn\StepRunnerInstallTrait;
use XF\AddOn\StepRunnerUninstallTrait;
use XF\AddOn\StepRunnerUpgradeTrait;

use XF\Db\Schema\Alter;
use XF\Db\Schema\Create;

class Setup extends \XF\AddOn\AbstractSetup
{
	use StepRunnerInstallTrait;
	use StepRunnerUpgradeTrait;
	use StepRunnerUninstallTrait;

	public function installStep1()
	{
		$this->schemaManager()->alterTable('xf_forum', function(Alter $table)
		{
			$table->addColumn('demo_portal_auto_feature', 'tinyint')->setDefault(0);
		});
	}
}
```

--------------------------------

### Run install step for Demo/Portal add-on

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/lets-build-an-add-on.mdx

Run this command in the terminal to execute the install step for the Demo/Portal add-on. This is required to apply the changes made in the setup class.

```sh
php cmd.php xf-addon:install-step Demo/Portal 4
```

--------------------------------

### Run install step with xf-addon:install-step

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/development-tools.mdx

Runs a specific install step from a Setup class built with the default StepRunner traits, without reinstalling the add-on.

```sh
php cmd.php xf-addon:install-step [addon_id] [step]
```

--------------------------------

### Setup.php - Basic add-on Setup class

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/add-on-structure.mdx

Place this file as Setup.php in the root of your add-on directory. It extends \XF\AddOn\AbstractSetup and must implement install(), upgrade(), and uninstall(). The upgrade() method checks the add-on version ID to conditionally alter the table.

```php
<?php

namespace Demo;

class Setup extends \XF\AddOn\AbstractSetup
{
	public function install(array $stepParams = [])
	{
		$this->schemaManager()->createTable('xf_demo', function(\XF\Db\Schema\Create $table)
		{
			$table->addColumn('demo_id', 'int');
		});
	}

	public function upgrade(array $stepParams = [])
	{
		if ($this->addOn->version_id < 1000170)
		{
			$this->schemaManager()->alterTable('xf_demo', function(\XF\Db\Schema\Alter $table)
			{
				$table->addColumn('foo', 'varchar', 10)->setDefault('');
			});
		}
	}

	public function uninstall(array $stepParams = [])
	{
		$this->schemaManager()->dropTable('xf_demo');
	}
}
```

--------------------------------

### Initial Setup class skeleton

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/lets-build-an-add-on.mdx

The initial skeleton of the Setup class with the required traits for install, upgrade, and uninstall steps.

```php
<?php

namespace Demo\Portal;

use XF\AddOn\AbstractSetup;
use XF\AddOn\StepRunnerInstallTrait;
use XF\AddOn\StepRunnerUninstallTrait;
use XF\AddOn\StepRunnerUpgradeTrait;

class Setup extends AbstractSetup
{
        use StepRunnerInstallTrait;
        use StepRunnerUpgradeTrait;
        use StepRunnerUninstallTrait;
}
```

--------------------------------

### Install XenForo with CLI: php cmd.php xf:install

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/index.mdx

Run this command from the root of the uploaded XenForo files to start the installation. You will be prompted for initial administrator credentials and board title. After completion, the database tables and master data are imported.

```sh
php cmd.php xf:install
```

--------------------------------

### macOS development environment setup commands

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/appendix/macos-dev.mdx

Complete terminal command summary for setting up a macOS development environment with Homebrew, MariaDB, Apache, MailHog, ImageMagick, Elasticsearch, and multiple PHP versions (5.6, 7.4, 8.0). Includes installing Xdebug and imagick via PECL, starting services, and notes that the imagick install fails with PHP 8.0 at the time of writing.

```bash
#!/bin/bash

# install macOS command line development tools
sudo xcode-select --install;

# install homebrew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)";

# additional homebrew package sources
brew tap elastic/tap;
brew tap shivammathur/php;

# install homebrew packages
brew install pkg-config mariadb httpd mailhog imagemagick elastic/tap/elasticsearch-full;

# install php 5.6
brew install shivammathur/php/php@5.6;
pecl install xdebug-2.5.5;
printf "\n" | pecl install imagick;

# install php 7.4
brew install shivammathur/php/php@7.4;
pecl install xdebug;
printf "\n" | pecl install imagick;

# install php 8.0
brew install shivammathur/php/php@8.0;
pecl install xdebug;
# this command fails with PHP 8.0 at the time of writing
printf "\n" | pecl install imagick;

# start and setup mariadb
brew services start mariadb;
sudo /usr/local/bin/mysql_upgrade;
sudo /usr/local/bin/mysql_secure_installation;

#
# Edit config files for Apache and PHP at this point,
# see the 'Configuration summary' below
#

# start the rest of the services
brew services start elasticsearch-full;
brew services start php@5.6;
brew services start php@7.4;
brew services start php@8.0;
brew services start httpd;
```

--------------------------------

### Start and secure MariaDB

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/appendix/macos-dev.mdx

Start MariaDB and run the upgrade script, then run the secure installation script. The first command may prompt for the MySQL root password; since none is set yet, press Enter. The second command accepts defaults except for setting the root password, which can be 'root' for development.

```bash
brew services start mariadb;
sudo /usr/local/bin/mysql_upgrade;
```

```bash
sudo /usr/local/bin/mysql_secure_installation;
```

--------------------------------

### Add uninstall methods to Setup.php

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/lets-build-an-add-on.mdx

Adds three uninstall methods to the Setup class to drop columns and a table when the add-on is uninstalled. These correspond to the first three install steps. Widgets and other add-on data are removed automatically.

```php
public function uninstallStep1()
{
	$this->schemaManager()->alterTable('xf_forum', function(Alter $table)
	{
		$table->dropColumns('demo_portal_auto_feature');
	});
}

public function uninstallStep2()
{
	$this->schemaManager()->alterTable('xf_thread', function(Alter $table)
	{
		$table->dropColumns('demo_portal_featured');
	});
}

public function uninstallStep3()
{
	$this->schemaManager()->dropTable('xf_demo_portal_featured_thread');
}
```

--------------------------------

### Clone, install, and run Docusaurus locally

Source: https://github.com/xenforo-ltd/docs/blob/main/CONTRIBUTING.md

Clone the documentation repository, install dependencies with pnpm, and start the local Docusaurus development server. The server runs at http://localhost:3000/ and watches for changes to reload automatically.

```bash
git clone git@github.com:xenforo-ltd/docs.git
```

```bash
pnpm install
```

```bash
pnpm start
```

--------------------------------

### Replace MariaDB with MySQL for CJK support

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/appendix/macos-dev.mdx

For CJK users, replace MariaDB with MySQL in the Homebrew installation and service start commands. The first pair installs packages with either mariadb or mysql, and the second pair starts the corresponding database service.

```bash
brew install pkg-config mariadb httpd mailhog imagemagick elastic/tap/elasticsearch-full shivammathur/php/php@5.6 shivammathur/php/php@7.4 shivammathur/php/php@8.0;
```

```bash
brew install pkg-config mysql httpd mailhog imagemagick elastic/tap/elasticsearch-full shivammathur/php/php@5.6 shivammathur/php/php@7.4 shivammathur/php/php@8.0;
```

```bash
brew services start mariadb
```

```bash
brew services start mysql
```

--------------------------------

### Start services with brew services

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/appendix/macos-dev.mdx

Starts all required services (Elasticsearch, PHP versions, and Apache) and configures them to load at system startup.

```bash
brew services start elasticsearch-full;
brew services start php@5.6;
brew services start php@7.4;
brew services start php@8.0;
brew services start httpd;
```

--------------------------------

### Install Homebrew: /bin/bash -c "$(curl -fsSL ...)"

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/appendix/macos-dev.mdx

Run in Terminal to install Homebrew. Watch the output and confirm as necessary. Homebrew installs to /usr/local on Intel or /opt/homebrew on Apple Silicon.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)";
```

--------------------------------

### Create sidebar widgets in Setup class installStep4()

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/lets-build-an-add-on.mdx

Add this method to the Setup class to create the sidebar widgets for the demo portal view. It duplicates the widgets from the forum_list_sidebar position and assigns them to the demo_portal_view_sidebar position with different sort orders.

```php
public function installStep4()
{
	$this->createWidget('demo_portal_view_members_online', 'members_online', [
		'positions' => ['demo_portal_view_sidebar' => 10]
	]);

	$this->createWidget('demo_portal_view_new_posts', 'new_posts', [
		'positions' => ['demo_portal_view_sidebar' => 20]
	]);

	$this->createWidget('demo_portal_view_new_profile_posts', 'new_profile_posts', [
		'positions' => ['demo_portal_view_sidebar' => 30]
	]);

	$this->createWidget('demo_portal_view_forum_statistics', 'forum_statistics', [
		'positions' => ['demo_portal_view_sidebar' => 40]
	]);

	$this->createWidget('demo_portal_view_share_page', 'share_page', [
		'positions' => ['demo_portal_view_sidebar' => 50]
	]);
}
```

--------------------------------

### Run install steps via CLI

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/lets-build-an-add-on.mdx

Commands to run each install step individually using the xf-addon:install-step CLI command.

```sh
php cmd.php xf-addon:install-step Demo/Portal 1
```

```sh
php cmd.php xf-addon:install-step Demo/Portal 2
```

```sh
php cmd.php xf-addon:install-step Demo/Portal 3
```

--------------------------------

### Install Xcode command line tools: sudo xcode-select --install

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/appendix/macos-dev.mdx

Run in Terminal before installing Homebrew to install the Xcode command line tools. Prompts for your password and opens an installation window. Re-run after macOS updates, as tools are sometimes not retained.

```bash
sudo xcode-select --install;
```

--------------------------------

### Configure index.php for XenForo redirects

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/manual/importing/import-notes-vbulletin.mdx

This is the contents of the index.php file that you need to copy to your vBulletin installation directory when XenForo and vBulletin are at different URLs. Replace the value of $dir with the full path to your XenForo directory, for example: $dir = '/users/example-user/htdocs/new-forums';

```PHP
<?php

// Enter the full path to your XenForo directory here:
$dir = '/home/username/public_html/xenforo2';

require($dir . '/src/XF.php');

XF::start($dir);
XF::runApp('XF301VB\Pub\App');
```

--------------------------------

### Install PHP, Apache, and optional packages

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/appendix/linux-dev.mdx

Installs PHP-FPM versions 5.6, 7.4, and 8.0, PHP modules, Apache with FastCGI, and optional TablePlus and ElasticSearch, plus MariaDB. Save as install.sh, chmod 700, and run.

```bash
#!/bin/bash

# PHP stuff
sudo apt install php5.6-fpm -y
sudo apt install php7.4-fpm -y
sudo apt install php8.0-fpm -y
sudo apt install php-pear -y
sudo apt install php-memcache -y

# PHP modules
for module in xdebug imagick gettext gd bcmath bz2 curl dba xml gmp intl ldap mbstring mysql odbc soap zip enchant sqlite3
do
    for version in 7.4 5.6 8.0
    do
        sudo apt install php${version}-${module} -y
    done
done

# Apache web server
sudo apt install apache2 -y
# enable Apache FastCGI / FPM module
sudo a2enmod proxy_fcgi

# TablePlus (optional)
sudo apt install tableplus -y

# ElasticSearch (optional)
sudo apt install elasticsearch -y

# MariaDB (MySQL)
sudo apt install mariadb-server -y
```

--------------------------------

### Install PHP, Apache, MariaDB, ElasticSearch, Mailhog, ImageMagick via Homebrew

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/appendix/macos-dev.mdx

Taps additional package sources and installs three PHP versions, Apache, MariaDB, ElasticSearch, Mailhog, and ImageMagick. This command may take a few minutes to complete.

```bash
brew tap elastic/tap;
brew tap shivammathur/php;
brew install pkg-config mariadb httpd mailhog imagemagick elastic/tap/elasticsearch-full shivammathur/php/php@5.6 shivammathur/php/php@7.4 shivammathur/php/php@8.0;
```

--------------------------------

### Install add-on with xf:addon-install

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/index.mdx

Installs the specified add-on if it is available and passes the file health check. If development output is available, you will be prompted to confirm using it instead of the exported data XML files.

```sh
php cmd.php xf:addon-install [addon_id]
```

--------------------------------

### addon.json require property example

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/add-on-structure.mdx

Example of the require property in addon.json, showing how to specify requirements for XenForo version, PHP version, and a PHP extension. Each requirement is an array with the product ID as the key, the version as the first element, and a human-readable description as the second element.

```json
...
  "require": {
      "XF": [2000010, "XenForo 2.0.0+"],
      "php": ["5.4.0", "PHP 5.4.0+"],
      "php-ext/json": ["*", "JSON extension"]
  }
...
```

--------------------------------

### installStep3 method

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/lets-build-an-add-on.mdx

Creates the xf_demo_portal_featured_thread table to log featured threads.

```php
public function installStep3()
{
    $this->schemaManager()->createTable('xf_demo_portal_featured_thread', function(Create $table)
    {
        $table->addColumn('thread_id', 'int');
        $table->addColumn('featured_date', 'int');
        $table->addPrimaryKey('thread_id');
    });
}
```

--------------------------------

### Create a new add-on with xf-addon:create

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/development-tools.mdx

Initializes and creates a new add-on. Prompts for an add-on ID, title, version ID (e.g. 1000010), and version string (e.g. 1.0.0 Alpha), then offers to write addon.json and optionally add a Setup.php file.

```sh
php cmd.php xf-addon:create
```

--------------------------------

### installStep2 method

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/lets-build-an-add-on.mdx

Adds a column to the xf_thread table to cache whether a thread is featured.

```php
public function installStep2()
{
    $this->schemaManager()->alterTable('xf_thread', function(Alter $table)
    {
        $table->addColumn('demo_portal_featured', 'tinyint')->setDefault(0);
    });
}
```

--------------------------------

### Verify Xdebug installation with php -v

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/appendix/windows-dev.mdx

Output of `php -v` after installing Xdebug. The line `with Xdebug v2.9.8` confirms Xdebug is properly installed and loaded.

```text
C:\Users\Kier>php -v
PHP 7.2.19 (cli) (built: May 29 2019 13:58:59) ( ZTS MSVC15 (Visual C++ 2017) x64 )
Copyright (c) 1997-2018 The PHP Group
Zend Engine v3.2.0, Copyright (c) 1998-2018 Zend Technologies
    with Xdebug v2.9.8, Copyright (c) 2002-2020, by Derick Rethans
```

--------------------------------

### GET /resource-categories/flattened

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/api/get-resource-categories-flattened.api.mdx

Get a flattened list of resource categories.

```APIDOC
## GET /resource-categories/flattened

### Description
Get a flattened list of resource categories.

### Method
GET

### Endpoint
/resource-categories/flattened
```

--------------------------------

### Initial addon.json file

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/lets-build-an-add-on.mdx

The generated addon.json file after running the create command. It contains default values that will be edited in the next step.

```json
{
    "legacy_addon_id": "",
    "title": "Demo - Portal",
    "description": "",
    "version_id": 1000010,
    "version_string": "1.0.0 Alpha",
    "dev": "",
    "dev_url": "",
    "faq_url": "",
    "support_url": "",
    "extra_urls": [],
    "require": [],
    "icon": ""
}
```

--------------------------------

### GET /users/

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/api/get-users.api.mdx

This endpoint retrieves a list of users, ordered alphabetically. It is a GET request to /users/.

```APIDOC
## GET /users/

### Description
Get a list of users. Results are ordered alphabetically.

### Method
GET

### Endpoint
/users/

### Parameters
No parameters are documented.

### Request Example
No request body is documented.

### Response
#### Success Response (200)
No response schema is documented.

#### Response Example
No response example is documented.

### Error Handling
No error status codes are documented.
```

--------------------------------

### GET /resources/{id}/

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/api/get-resources-id.api.mdx

Documentation for the GET /resources/{id}/ endpoint, which retrieves information about a specific resource.

```APIDOC
## GET /resources/{id}/

### Description
Get information about the specified resource.

### Method
GET

### Endpoint
/resources/{id}/

### Parameters
#### Path Parameters
- **id** - Required - The ID of the resource to retrieve.

### Response
#### Success Response (200)
Returns information about the specified resource.

#### Response Example
```json
{
  "resource": {
    "resource_id": 1,
    "title": "Example Resource",
    "description": "This is an example resource."
  }
}
```

#### Error Response (404)
Returns an error if the resource with the specified ID does not exist.

#### Response Example
```json
{
  "error": "Resource not found"
}
```
```

--------------------------------

### GET /resource-categories/

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/api/get-resource-categories.api.mdx

This endpoint retrieves the resource category tree. It is a GET request to /resource-categories/ and does not require any parameters.

```APIDOC
## GET /resource-categories/

### Description
Get the resource category tree.

### Method
GET

### Endpoint
/resource-categories/

### Parameters
No parameters are documented for this endpoint.

### Response
No response schema is documented for this endpoint.
```

--------------------------------

### GET /nodes/flattened

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/api/get-nodes-flattened.api.mdx

Get a flattened node tree. Traversing this returns a list of nodes in the expected order.

```APIDOC
## GET /nodes/flattened

### Description
Get a flattened node tree. Traversing this returns a list of nodes in the expected order.

### Method
GET

### Endpoint
/nodes/flattened

### Parameters
No parameters are documented for this endpoint.

### Request Example
No request body is documented for this endpoint.

### Response
#### Success Response (200)
No response schema is documented for this endpoint.

#### Response Example
No response example is documented for this endpoint.
```

--------------------------------

### Run upgrade step with xf-addon:upgrade-step

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/development-tools.mdx

Runs a specific upgrade step from a Setup class built with the default StepRunner traits, without performing a full upgrade.

```sh
php cmd.php xf-addon:upgrade-step [addon_id] [version] [step]
```

--------------------------------

### Customize build process with build.json

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/development-tools.mdx

Typical build.json file for customizing the add-on build process. Use additional_files to copy files or directories (checked in the add-on _files directory first), minify to minify specified JS files (or '*' for all in the js directory), rollup to combine JS files into a single file, and exec to run shell commands before the package is finalized. Placeholders like {title}, {version_string}, and {version_id} are replaced with scalar values from the XF\AddOn\AddOn object.

```json
{
	"additional_files": [
		"js/demo/portal"
	],
	"minify": [
		"js/demo/portal/a.js",
		"js/demo/portal/b.js"
	],
	"rollup": {
		"js/demo/portal/ab-rollup.js": [
			"js/demo/portal/a.min.js",
			"js/demo/portal/b.min.js"
		]
	},
	"exec": [
		"echo '{title} version {version_string} ({version_id}) has been built successfully!' > 'src/addons/Demo/Portal/_build/built.txt'"
	]
}
```

--------------------------------

### Change cookie prefix in config.php

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/development-tools.mdx

Changes the cookie prefix for a XenForo installation. Recommended when using two or more XF installs on the same domain to prevent cookies from being overwritten, which can cause issues like being logged out of one install when logging into another.

```php
$config['cookie']['prefix'] = 'anything_';
```

--------------------------------

### Template rendering view parameters

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/controller-basics.mdx

The demo_example template uses the view parameters passed from the controller action. The template outputs the values of the hello and world variables.

```html
{$hello} {$world}
```

```html
Hello world!
```

--------------------------------

### GET /users/find-name

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/api/get-users-find-name.api.mdx

This endpoint allows you to find users by a prefix of their user name. It is a GET request to the /users/find-name endpoint.

```APIDOC
## GET /users/find-name

### Description
Find users by a prefix of their user name.

### Method
GET

### Endpoint
/users/find-name
```

--------------------------------

### GET /forums/{id}/threads

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/api/get-forums-id-threads.api.mdx

Fetches threads for a specific forum. Use the forum ID in the path to get its threads.

```APIDOC
## GET /forums/{id}/threads

### Description
Retrieves a list of threads for the specified forum.

### Method
GET

### Endpoint
/forums/{id}/threads

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the forum.

### Response
#### Success Response (200)
Returns a list of threads.

#### Response Example
```json
{
  "threads": []
}
```
```

--------------------------------

### Build add-on release with xf-addon:build-release

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/development-tools.mdx

Run this command to build a release ZIP for an add-on. It first runs the xf-addon:export command, collects files into a temporary _build directory, and writes the ZIP to the _releases directory as <ADDON ID>-<VERSION STRING>.zip, including the hashes.json file.

```sh
php cmd.php xf-addon:build-release [addon_id]
```

--------------------------------

### Run uninstall step with xf-addon:uninstall-step

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/development-tools.mdx

Runs a specific uninstall step from a Setup class built with the default StepRunner traits, without uninstalling the add-on.

```sh
php cmd.php xf-addon:uninstall-step [addon_id] [step]
```

--------------------------------

### Example dump output for an array

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/development-tools.mdx

Example output of XF::dumpSimple when dumping an array. It is similar to var_dump but modified for readability and wrapped in <pre> tags.

```text
array(2) {
  ["user_id"] => int(1)
  ["username"] => string(5) "Admin"
}
```

--------------------------------

### Add APT repositories for Ubuntu

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/appendix/linux-dev.mdx

Adds the ondrej/php PPA for PHP versions, optional TablePlus and ElasticSearch repositories, then updates and upgrades the system. Run these commands in a terminal on Ubuntu.

```bash
#!/bin/bash

# PHP versions for Ubuntu
sudo add-apt-repository -y ppa:ondrej/php

# TablePlus (optional)
wget -O - -q http://deb.tableplus.com/apt.tableplus.com.gpg.key | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://deb.tableplus.com/debian tableplus main"

# ElasticSearch (optional)
wget -qO - https://artifacts.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add -
echo "deb https://artifacts.elastic.co/packages/7.x/apt stable main" | sudo tee /etc/apt/sources.list.d/elastic-7.x.list

# Fetch the latest version info and upgrade existing packages
sudo apt update -y
sudo apt upgrade -y
```

--------------------------------

### Run mysql_secure_installation

Source: https://github.com/xenforo-ltd/docs/blob/main/docs/devs/appendix/linux-dev.mdx

Run the MariaDB/MySQL secure installation script. Accept defaults but ensure a root password is set.

```sh
sudo mysql_secure_installation
```
Tokens:
Raw