ProfiWiki
Wolfgang Fahl
Why use the original MediaWiki?[edit]
- there are some 2.500 Extensions available
- there are many different skins available
- it is free (as in free beer)
- it is free (as in OpenSource)
- the WikiMedia Foundation keeps maintaining it as the infrastucture for WikiPedia
Installation[edit]
Usage[edit]
command line[edit]
profwiki -h
zsh: command not found: profwiki
wf@fixit ProfiWiki % profiwiki -h
usage: profiwiki [-h] [-cn CONTAINER_NAME] [-d] [-el [EXTENSIONNAMELIST ...]]
[-ej EXTENSIONJSONFILE] [-f] [-fu] [--host HOST]
[-dp DOCKER_PATH] [--logo LOGO] [-mv MARIADBVERSION]
[--mysqlPassword MYSQLPASSWORD] [-rp] [-p PASSWORD]
[-pl PASSWORD_LENGTH] [--prefix PREFIX] [--prot PROT]
[--script_path SCRIPT_PATH] [--url URL] [-sp SQL_PORT]
[-smw SMW_VERSION] [-u USER] [-q] [-bp BASE_PORT]
[-vl [VERSIONS ...]] [--about] [--apache] [--all] [--bash]
[--create] [--check] [--update] [--cron] [--down] [--patch]
[--list] [-fa] [-wuc] [-pu] [-i] [-V]
[--debugServer DEBUGSERVER] [--debugPort DEBUGPORT]
[--debugPathMapping DEBUGPATHMAPPING [DEBUGPATHMAPPING ...]]
Copyright 2015-2024 contributors. All rights reserved.
Licensed under the Apache License 2.0
http://www.apache.org/licenses/LICENSE-2.0
Distributed on an "AS IS" basis without warranties
or conditions of any kind, either express or implied.
options:
-h, --help show this help message and exit
-cn CONTAINER_NAME, --container_name CONTAINER_NAME
set container name (only valid and recommended for
single version call)
-d, --debug enable debug mode [default: False]
-el [EXTENSIONNAMELIST ...], --extensionList [EXTENSIONNAMELIST ...]
list of extensions to be installed [default: ['Admin
Links', 'Diagrams', 'Graph', 'Header Tabs',
'ImageMap', 'ImageLink', 'MagicNoCache', 'Maps9',
'Mermaid', 'MsUpload', 'Nuke', 'Page Forms',
'ParserFunctions', 'PDFEmbed', 'Renameuser', 'Replace
Text', 'Semantic Result Formats', 'SyntaxHighlight',
'Variables', 'UserFunctions', 'YouTube']]
-ej EXTENSIONJSONFILE, --extensionJson EXTENSIONJSONFILE
additional extension descriptions default: [default:
None]
-f, --forceRebuild force rebuilding [default: False]
-fu, --force_user force overwrite of wikiuser
--host HOST the host to serve / listen from [default:
fixit.bitplan.com]
-dp DOCKER_PATH, --docker_path DOCKER_PATH
the base directory to store docker and jinja template
files [default: /Users/wf/.pymediawikidocker]
--logo LOGO set Logo [default: https://wiki.bitplan.com/images/wik
i/thumb/6/63/Profiwikiicon.png/96px-Profiwikiicon.png]
-mv MARIADBVERSION, --mariaDBVersion MARIADBVERSION
mariaDB Version to be installed [default: 10.11]
--mysqlPassword MYSQLPASSWORD
set sqlRootPassword [default: None] - random password
if None
-rp, --random_password
create random password and create wikiuser while at it
-p PASSWORD, --password PASSWORD
set password for initial user [default: sysop-1234!]
-pl PASSWORD_LENGTH, --password_length PASSWORD_LENGTH
set the password length for random passwords[default:
15]
--prefix PREFIX the container name prefix to use [default: pw]
--prot PROT change to https in case [default: http]
--script_path SCRIPT_PATH
change to any script_path you might need to set
[default: ]
--url URL will set prot host,script_path, and optionally port
based on the url given [default: None]
-sp SQL_PORT, --sql_base_port SQL_PORT
set base mySql port 3306 to be exposed - incrementing
by one for each version [default: 9078]
-smw SMW_VERSION, --smw_version SMW_VERSION
set SemanticMediaWiki Version to be installed default
is None - no installation of SMW
-u USER, --user USER set username of initial user with sysop rights
[default: Sysop]
-q, --quiet not verbose [default: False]
-bp BASE_PORT, --base_port BASE_PORT
set how base html port 80 to be exposed - incrementing
by one for each version [default: 9079]
-vl [VERSIONS ...], --version_list [VERSIONS ...]
mediawiki versions to create docker applications for
[default: ['1.39.8']]
--about show about info [default: False]
--apache generate apache configuration
--all do all necessary steps for a full setup
--bash bash into container
--create create the wiki
--check check the wiki
--update start the update script -e.g. to fix SMW key
--cron start cron service
--down shutdown the wiki [default: False]
--patch apply LocalSettings.php patches [default: False]
--list list the available profi wikis [default: False]
-fa, --fontawesome install fontawesome
-wuc, --wikiuser_check
check wikiuser
-pu, --plantuml install plantuml
-i, --info show system info
-V, --version show program's version number and exit
--debugServer DEBUGSERVER
remote debug Server
--debugPort DEBUGPORT
remote debug Port
--debugPathMapping DEBUGPATHMAPPING [DEBUGPATHMAPPING ...]
remote debug Server path mapping - needs two arguments
1st: remotePath 2nd: local Path
command line[edit]
profwiki -h
zsh: command not found: profwiki
wf@fixit ProfiWiki % profiwiki -h
usage: profiwiki [-h] [-cn CONTAINER_NAME] [-d] [-el [EXTENSIONNAMELIST ...]]
[-ej EXTENSIONJSONFILE] [-f] [-fu] [--host HOST]
[-dp DOCKER_PATH] [--logo LOGO] [-mv MARIADBVERSION]
[--mysqlPassword MYSQLPASSWORD] [-rp] [-p PASSWORD]
[-pl PASSWORD_LENGTH] [--prefix PREFIX] [--prot PROT]
[--script_path SCRIPT_PATH] [--url URL] [-sp SQL_PORT]
[-smw SMW_VERSION] [-u USER] [-q] [-bp BASE_PORT]
[-vl [VERSIONS ...]] [--about] [--apache] [--all] [--bash]
[--create] [--check] [--update] [--cron] [--down] [--patch]
[--list] [-fa] [-wuc] [-pu] [-i] [-V]
[--debugServer DEBUGSERVER] [--debugPort DEBUGPORT]
[--debugPathMapping DEBUGPATHMAPPING [DEBUGPATHMAPPING ...]]
Copyright 2015-2024 contributors. All rights reserved.
Licensed under the Apache License 2.0
http://www.apache.org/licenses/LICENSE-2.0
Distributed on an "AS IS" basis without warranties
or conditions of any kind, either express or implied.
options:
-h, --help show this help message and exit
-cn CONTAINER_NAME, --container_name CONTAINER_NAME
set container name (only valid and recommended for
single version call)
-d, --debug enable debug mode [default: False]
-el [EXTENSIONNAMELIST ...], --extensionList [EXTENSIONNAMELIST ...]
list of extensions to be installed [default: ['Admin
Links', 'Diagrams', 'Graph', 'Header Tabs',
'ImageMap', 'ImageLink', 'MagicNoCache', 'Maps9',
'Mermaid', 'MsUpload', 'Nuke', 'Page Forms',
'ParserFunctions', 'PDFEmbed', 'Renameuser', 'Replace
Text', 'Semantic Result Formats', 'SyntaxHighlight',
'Variables', 'UserFunctions', 'YouTube']]
-ej EXTENSIONJSONFILE, --extensionJson EXTENSIONJSONFILE
additional extension descriptions default: [default:
None]
-f, --forceRebuild force rebuilding [default: False]
-fu, --force_user force overwrite of wikiuser
--host HOST the host to serve / listen from [default:
fixit.bitplan.com]
-dp DOCKER_PATH, --docker_path DOCKER_PATH
the base directory to store docker and jinja template
files [default: /Users/wf/.pymediawikidocker]
--logo LOGO set Logo [default: https://wiki.bitplan.com/images/wik
i/thumb/6/63/Profiwikiicon.png/96px-Profiwikiicon.png]
-mv MARIADBVERSION, --mariaDBVersion MARIADBVERSION
mariaDB Version to be installed [default: 10.11]
--mysqlPassword MYSQLPASSWORD
set sqlRootPassword [default: None] - random password
if None
-rp, --random_password
create random password and create wikiuser while at it
-p PASSWORD, --password PASSWORD
set password for initial user [default: sysop-1234!]
-pl PASSWORD_LENGTH, --password_length PASSWORD_LENGTH
set the password length for random passwords[default:
15]
--prefix PREFIX the container name prefix to use [default: pw]
--prot PROT change to https in case [default: http]
--script_path SCRIPT_PATH
change to any script_path you might need to set
[default: ]
--url URL will set prot host,script_path, and optionally port
based on the url given [default: None]
-sp SQL_PORT, --sql_base_port SQL_PORT
set base mySql port 3306 to be exposed - incrementing
by one for each version [default: 9078]
-smw SMW_VERSION, --smw_version SMW_VERSION
set SemanticMediaWiki Version to be installed default
is None - no installation of SMW
-u USER, --user USER set username of initial user with sysop rights
[default: Sysop]
-q, --quiet not verbose [default: False]
-bp BASE_PORT, --base_port BASE_PORT
set how base html port 80 to be exposed - incrementing
by one for each version [default: 9079]
-vl [VERSIONS ...], --version_list [VERSIONS ...]
mediawiki versions to create docker applications for
[default: ['1.39.8']]
--about show about info [default: False]
--apache generate apache configuration
--all do all necessary steps for a full setup
--bash bash into container
--create create the wiki
--check check the wiki
--update start the update script -e.g. to fix SMW key
--cron start cron service
--down shutdown the wiki [default: False]
--patch apply LocalSettings.php patches [default: False]
--list list the available profi wikis [default: False]
-fa, --fontawesome install fontawesome
-wuc, --wikiuser_check
check wikiuser
-pu, --plantuml install plantuml
-i, --info show system info
-V, --version show program's version number and exit
--debugServer DEBUGSERVER
remote debug Server
--debugPort DEBUGPORT
remote debug Port
--debugPathMapping DEBUGPATHMAPPING [DEBUGPATHMAPPING ...]
remote debug Server path mapping - needs two arguments
1st: remotePath 2nd: local Path