tikiwiki/tiki-manager

Tiki Wiki CMS Groupware

v0.1.1 2024-10-30 18:01 UTC

Requires

• php: ^7.4 || ^8.0
• ext-bz2: *
• ext-json: *
• ext-pdo: *
• composer/semver: ^3.2
• dragonmantank/cron-expression: ^3.0
• gitonomy/gitlib: ^1.2
• laminas/laminas-mail: ^2.12
• laminas/laminas-servicemanager: ^3.4
• monolog/monolog: ^1.26 || ^2.0 || ^3.0
• phpseclib/phpseclib: ^3.0
• psr/log: ^1.1 || ^2.0 || ^3.0
• symfony/console: ^3.4 || ^4.0 || ^5.0 || ^6.0 || ^7.0
• symfony/dependency-injection: ^4.4 || ^5.0 || ^6.0 || ^7.0
• symfony/dotenv: ^4.3 || ^5.0 || ^6.0 || ^7.0
• symfony/event-dispatcher: ^4.1 || ^5.0 || ^6.0 || ^7.0
• symfony/filesystem: ^3.4 || ^4.1 || ^5.0 || ^6.0 || ^7.0
• symfony/finder: ^4.4 || ^5.0 || ^6.0 || ^7.0
• symfony/http-client: ^4.1 || ^5.0 || ^6.0 || ^7.0
• symfony/process: ^3.4 || ^4.3 || ^5.0 || ^6.0 || ^7.0
• symfony/yaml: ^3.4 || ^4.3 || ^5.0 || ^6.0 || ^7.0

Requires (Dev)

• bamarni/composer-bin-plugin: ^1.3
• mikey179/vfsstream: ^1.6
• phpcompatibility/php-compatibility: ^9.3
• phpstan/phpstan: ^1.4
• squizlabs/php_codesniffer: ^3.3
• symfony/phpunit-bridge: ^5.4

LGPL-2.1

README

Installation

There are four options

Via WikiSuite: https://wikisuite.org/How-to-install-WikiSuite

Standalone https://doc.tiki.org/Manager#Installation

As a Tiki Package https://doc.tiki.org/Tiki-Manager-Package

Using a PHP Archive file (tiki-manager.phar). See later in this README file for more informations.

Configuration

To easily configure Tiki Manager, copy the .env.dist file to .env and insert your configurations for the uncommented (#) entries.

Version Control System

Tiki Manager by default uses Git and the main public repository at https://gitlab.com/tikiwiki/tiki. If you want to use SVN as your default vcs (but you shouldn't as SVN is deprecated) or another repository please add the following lines to your .env file.

DEFAULT_VCS=svn
GIT_TIKIWIKI_URI=<CUSTOM_GIT_REPOSITORY_URL>
SVN_TIKIWIKI_URI=<CUSTOM_SVN_REPOSITORY_URL>

Behind a Proxy or without internet connection

Tiki Manager is able to use Tiki's distributed version packages as an alternative when there is no connection to external servers like GitLab or SourceForge.

Setting the default VCS to src, Tiki Manager will use existing packages in the data/tiki_src folder (default).

DEFAULT_VCS=src

Download the distributed Tiki packages, from https://sourceforge.net/projects/tikiwiki/files/, and save them into data/tiki_src folder.

Email settings

To configure Tiki Manager email sender address add the following line to your .env file.

FROM_EMAIL_ADDRESS=<SENDER_EMAIL_ADDRESS>

Configure SMTP Server

By default Tiki Manager uses sendmail to send email notifications. If you intend to use SMTP instead, add the following lines to your .env file.

SMTP_HOST=<SERVER_ADDRESS>
SMTP_PORT=<SERVER_PORT>
SMTP_USER=(optional if authentication is required)
SMTP_PASS=(optional if authentication is required)

Documentation

Documentation is at Tiki Documentation - Manager.

Releases

Tiki-manager releases are available on Gitlab - Tiki-manager releases.

Those release are automatically build by the Gitlab CI/CD when a new version tag is added. Only project maintainers can add such tags.

You can access the latest release description by using this permalink: https://gitlab.com/tikiwiki/tiki-manager/-/releases/permalink/latest

Using the PHP Archive tiki-manager.phar

You can download a PHP Archive file to use tiki-manager.phar as a single executable.

Those archive are available in following places:

• in the Gitlab Package Registry
• as assets on Gitlab releases

To get the latest released tiki-manager.phar you can use this permalink: https://gitlab.com/tikiwiki/tiki-manager/-/releases/permalink/latest/downloads/tiki-manager.phar

Download it in an empty directory, then follow the tiki-manager documentation to create your .env file.

Note: for now there is a bug with tiki-manager.phar: it does not download composer automatically. So you have to install it yourself for now.

Here is an example on how you can initiate tiki-manager.phar:

mkdir working_dir
cd working_dir
wget https://gitlab.com/tikiwiki/tiki-manager/-/releases/permalink/latest/downloads/tiki-manager.phar
wget -O .env https://gitlab.com/tikiwiki/tiki-manager/-/raw/master/.env.dist?ref_type=heads
# then edit the .env file before launching it for the first time.
chmod u+x tiki-manager.phar
./tiki-manager.phar -n list

Contributing

Thanks for your interest in contributing! Have a look through our issues section and submit a merge request.