Difference between revisions of "Dokuwiki"

From SME Server
Jump to navigationJump to search
m
 
(12 intermediate revisions by 7 users not shown)
Line 1: Line 1:
−
{{Languages}}
+
{{Languages|Dokuwiki}}
  
 
== dokuwiki for SME Server ==
 
== dokuwiki for SME Server ==
Line 5: Line 5:
  
 
=== Maintainer ===
 
=== Maintainer ===
−
[mailto:daniel@firewall-services.com[[User:VIP-ire|Daniel B.]]] from [http://www.firewall-services.com Firewall Services]
+
We have now imported these contribs originally built by Daniel into smecontribs.
 +
 
 +
[mailto:daniel@firewall-services.com][[User:VIP-ire|Daniel B.]] from [http://www.firewall-services.com Firewall Services]
 +
 
 +
===Version===
 +
{{#smeversion: smeserver-dokuwiki }}
 +
{{#smeversion: dokuwiki }}
 +
{{#smeversion: dokuwiki-plugins }}
  
 
=== Description ===
 
=== Description ===
 
DokuWiki is a simple to use and highly versatile Open Source wiki software that doesn't require a database. It is loved by users for its clean and readable syntax. The ease of maintenance, backup and integration makes it an administrator's favorite. Built in access controls and authentication connectors make DokuWiki especially useful in the enterprise context and the large number of plugins contributed by its vibrant community allow for a broad range of use cases beyond a traditional wiki.  
 
DokuWiki is a simple to use and highly versatile Open Source wiki software that doesn't require a database. It is loved by users for its clean and readable syntax. The ease of maintenance, backup and integration makes it an administrator's favorite. Built in access controls and authentication connectors make DokuWiki especially useful in the enterprise context and the large number of plugins contributed by its vibrant community allow for a broad range of use cases beyond a traditional wiki.  
  
−
=== Requirements ===
+
=== Installation 9.x===
−
You need the [[Fws|firewall-service]] repo to install this contribs
+
 
 +
v9 is now EOL and deprecated
 +
 
 +
=== Installation v10.x ===
  
−
=== Installation ===
+
{{Warning box|These contribs are still in the smedev repo for testing}}
−
This contrib is currently held in the fws repository, so the following commands will install on your smeserver.
 
  
−
yum install --enablerepo=fws smeserver-dokuwiki dokuwiki-plugins
+
To install normally you would use the following:
  
−
You will then need to activate the database changes etc.
+
yum --enablerepo=smecontribs install smeserver-dokuwiki dokuwiki dokuwiki-plugins
−
The 'official' way is to perform
 
  
−
signal-event post-upgrade;  signal-event reboot
+
You should not need a reboot.
  
−
or if you do not want to restart your computer
+
Any changes should be activated with
  
 
  signal-event webapps-update
 
  signal-event webapps-update
Line 30: Line 38:
  
 
=== Configuration ===
 
=== Configuration ===
−
A fex DB properties are available to control DokuWiki configuration:
+
A few DB properties are available to control DokuWiki configuration:
 
* '''AliasOnPrimary''' (enabled|disabled). Default is enabled. If disabled, the alias /dokuwiki will not be added in your main vhost in apache. This is only usefull if you want to create a dedicated vhost for DokuWiki
 
* '''AliasOnPrimary''' (enabled|disabled). Default is enabled. If disabled, the alias /dokuwiki will not be added in your main vhost in apache. This is only usefull if you want to create a dedicated vhost for DokuWiki
 
* '''Authentication''': can be either '''ldap''', which is the default. With this setting, all the accounts on your SME Server will be used. Group membership is available to handle ACL. The admin user has full access to all option. Other valid values are ''internal'', which will use the internal account in DokuWIki (you have to manually create accounts, or enable user registration in the configuration). The last value is 'LemonLDAP' which can be used to protect DokuWiki with [LemonLDAP-NG]. In this case, LemonLDAP::NG will handle authentication only, user information and group membership is looked up in LDAP, and authroization is handled by the DokuWiki ACL
 
* '''Authentication''': can be either '''ldap''', which is the default. With this setting, all the accounts on your SME Server will be used. Group membership is available to handle ACL. The admin user has full access to all option. Other valid values are ''internal'', which will use the internal account in DokuWIki (you have to manually create accounts, or enable user registration in the configuration). The last value is 'LemonLDAP' which can be used to protect DokuWiki with [LemonLDAP-NG]. In this case, LemonLDAP::NG will handle authentication only, user information and group membership is looked up in LDAP, and authroization is handled by the DokuWiki ACL
 
* '''access''' (public|private). Default is private, which means the wiki is only available from the internal networks (and IP allowed to access the server-manager). If set to public, the wiki will be available from anywhere
 
* '''access''' (public|private). Default is private, which means the wiki is only available from the internal networks (and IP allowed to access the server-manager). If set to public, the wiki will be available from anywhere
−
* ''status''' (enabled|disabled). If set to disabled, the wiki won't be available anymore
+
* '''status''' (enabled|disabled). If set to disabled, the wiki won't be available anymore
  
 
=== Backup and restore ===
 
=== Backup and restore ===
 
You should backup /etc/dokuwiki and /var/lib/dokuwiki (which store configuration and data respectivly)
 
You should backup /etc/dokuwiki and /var/lib/dokuwiki (which store configuration and data respectivly)
 +
 +
 +
=== Manual upgrade ===
 +
 +
{{Warning box| This is work in progress!}}
 +
 +
I had an existing RPM install and wondered if I could upgrade.
 +
 +
The latest fedora RPMs are patched to remove compose code from the dokuwiki code and use rpms.
 +
 +
I thought I would try and see if compose would work.
 +
 +
First I installed compose. See this link:
 +
 +
https://wiki.koozali.org/PHP#Installation_of_Composer
 +
 +
Next we get a copy of the dokuwiki code. Go here and get a download link:
 +
 +
https://download.dokuwiki.org/
 +
 +
cd ~
 +
mkdir -p /root/dokuwiki
 +
cd /root/dokuwiki
 +
wget https://download.dokuwiki.org/out/dokuwiki-c98g4519b5d16cfdee29a855275c5759f.tgz
 +
 +
Or from here (check the latest release):
 +
https://github.com/dokuwiki/dokuwiki/releases/download/release-2024-02-06a/dokuwiki-2024-02-06a.tgz
 +
 +
tar -zxvf dokuwiki-2024-02-06a.tgz
 +
cd dokuwiki
 +
chown -R apache:www *
 +
 +
Backup
 +
 +
mkdir -p /root/dokuwiki-backup/etc/dokuwiki
 +
mkdir -p /root/dokuwiki-backup/var/lib/dokuwiki
 +
 +
cp -r /etc/dokuwiki/* /root/dokuwiki-backup/etc/dokuwiki
 +
cp -r /var/lib/dokuwiki/* /root/dokuwiki-backup/var/lib/dokuwiki
 +
 +
Copy file over without trashing the remote symlinks to /etc/and /var
 +
 +
rsync -av -K /root/dokuwiki/dokuwiki/* /usr/share/dokuwiki/
 +
 +
cd /usr/share/dokuwiki
 +
chown -R apache:www *
 +
 +
Check you can access the wiki.
 +
 +
Now clean up the old files:
 +
https://www.dokuwiki.org/install:unused_files
 +
 +
cd /usr/share/dokuwiki
 +
grep -Ev '^($|#)' data/deleted.files | xargs -n 1 rm -vf
 +
 +
I may try and build an RPM to update this way at some stage.
  
 
=== Uninstall ===
 
=== Uninstall ===
Line 43: Line 107:
 
  signal-event post-upgrade;  signal-event reboot
 
  signal-event post-upgrade;  signal-event reboot
 
=== Bugs ===
 
=== Bugs ===
−
Sources for this contribs can be found in Firewall Service's repository [http://gitweb.firewall-services.com/?p=smeserver-dokuwiki;a=summary]
+
 
 +
Please use the relevant section to create a bug
 +
 
 +
smeserver-dokuwiki is listed in the [http://bugs.contribs.org/enter_bug.cgi?product=SME%20Contribs&component=smeserver-dokuwiki bugtracker contribs section].
 +
 
 +
{{#bugzilla:columns=id,product,version,status,summary |sort=id |order=desc |disablecache=1|component=smeserver-dokuwiki|noresultsmessage="No open bugs found."}}
 +
 
 +
 
 +
dokuwiki is listed in the [http://bugs.contribs.org/enter_bug.cgi?product=SME%20Contribs&component=dokuwiki bugtracker contribs section].
 +
 
 +
 
 +
{{#bugzilla:columns=id,product,version,status,summary |sort=id |order=desc |disablecache=1|component=dokuwiki|noresultsmessage="No open bugs found."}}
 +
 
 +
 
 +
dokuwiki-plugins is listed in the [http://bugs.contribs.org/enter_bug.cgi?product=SME%20Contribs&component=dokuwiki-plugins bugtracker contribs section].
 +
 
 +
 
 +
{{#bugzilla:columns=id,product,version,status,summary |sort=id |order=desc |disablecache=1|component=dokuwiki-plugins|noresultsmessage="No open bugs found."}}
 +
 
 +
=== Categories ===
 +
 
 
[[Category: Contrib]]
 
[[Category: Contrib]]
 
[[Category: Webapps]]
 
[[Category: Webapps]]

Latest revision as of 16:50, 18 July 2024

Geographylogo.png Languages: 

English  • français


dokuwiki for SME Server

PythonIcon.png Skill level: easy
The instructions on this page can be followed by a beginner.


Maintainer

We have now imported these contribs originally built by Daniel into smecontribs.

[1]Daniel B. from Firewall Services

Version

Contrib 10:
smeserver-dokuwiki
The latest version of smeserver-dokuwiki is available in the SME repository, click on the version number(s) for more information.


Contrib 10:
dokuwiki
The latest version of dokuwiki is available in the SME repository, click on the version number(s) for more information.


Contrib 10:
dokuwiki-plugins
The latest version of dokuwiki-plugins is available in the SME repository, click on the version number(s) for more information.


Description

DokuWiki is a simple to use and highly versatile Open Source wiki software that doesn't require a database. It is loved by users for its clean and readable syntax. The ease of maintenance, backup and integration makes it an administrator's favorite. Built in access controls and authentication connectors make DokuWiki especially useful in the enterprise context and the large number of plugins contributed by its vibrant community allow for a broad range of use cases beyond a traditional wiki.

Installation 9.x

v9 is now EOL and deprecated

Installation v10.x

Warning.png Warning:
These contribs are still in the smedev repo for testing


To install normally you would use the following: 

yum --enablerepo=smecontribs install smeserver-dokuwiki dokuwiki dokuwiki-plugins

You should not need a reboot.

Any changes should be activated with 

signal-event webapps-update

There is no panel in the server-manager, you can go to https://sme-ip/dokuwiki and perform a login with users and passwords of your internal ldap.

Configuration

A few DB properties are available to control DokuWiki configuration:

  • AliasOnPrimary (enabled|disabled). Default is enabled. If disabled, the alias /dokuwiki will not be added in your main vhost in apache. This is only usefull if you want to create a dedicated vhost for DokuWiki
  • Authentication: can be either ldap, which is the default. With this setting, all the accounts on your SME Server will be used. Group membership is available to handle ACL. The admin user has full access to all option. Other valid values are internal, which will use the internal account in DokuWIki (you have to manually create accounts, or enable user registration in the configuration). The last value is 'LemonLDAP' which can be used to protect DokuWiki with [LemonLDAP-NG]. In this case, LemonLDAP::NG will handle authentication only, user information and group membership is looked up in LDAP, and authroization is handled by the DokuWiki ACL
  • access (public|private). Default is private, which means the wiki is only available from the internal networks (and IP allowed to access the server-manager). If set to public, the wiki will be available from anywhere
  • status (enabled|disabled). If set to disabled, the wiki won't be available anymore

Backup and restore

You should backup /etc/dokuwiki and /var/lib/dokuwiki (which store configuration and data respectivly)


Manual upgrade

Warning.png Warning:
This is work in progress!


I had an existing RPM install and wondered if I could upgrade.

The latest fedora RPMs are patched to remove compose code from the dokuwiki code and use rpms.

I thought I would try and see if compose would work.

First I installed compose. See this link:

https://wiki.koozali.org/PHP#Installation_of_Composer

Next we get a copy of the dokuwiki code. Go here and get a download link:

https://download.dokuwiki.org/ 

cd ~
mkdir -p /root/dokuwiki
cd /root/dokuwiki
wget https://download.dokuwiki.org/out/dokuwiki-c98g4519b5d16cfdee29a855275c5759f.tgz

Or from here (check the latest release): 

https://github.com/dokuwiki/dokuwiki/releases/download/release-2024-02-06a/dokuwiki-2024-02-06a.tgz

tar -zxvf dokuwiki-2024-02-06a.tgz
cd dokuwiki
chown -R apache:www *

Backup 

mkdir -p /root/dokuwiki-backup/etc/dokuwiki
mkdir -p /root/dokuwiki-backup/var/lib/dokuwiki

cp -r /etc/dokuwiki/* /root/dokuwiki-backup/etc/dokuwiki
cp -r /var/lib/dokuwiki/* /root/dokuwiki-backup/var/lib/dokuwiki

Copy file over without trashing the remote symlinks to /etc/and /var 

rsync -av -K /root/dokuwiki/dokuwiki/* /usr/share/dokuwiki/

cd /usr/share/dokuwiki
chown -R apache:www *

Check you can access the wiki.

Now clean up the old files: https://www.dokuwiki.org/install:unused_files 

cd /usr/share/dokuwiki
grep -Ev '^($|#)' data/deleted.files | xargs -n 1 rm -vf

I may try and build an RPM to update this way at some stage.

Uninstall

yum remove smeserver-dokuwiki dokuwiki-plugins dokuwiki
signal-event post-upgrade;  signal-event reboot

Bugs

Please use the relevant section to create a bug

smeserver-dokuwiki is listed in the bugtracker contribs section.

IDProductVersionStatusSummary
10583SME Contribs9.2CONFIRMEDExtension directory is not writable


dokuwiki is listed in the bugtracker contribs section.


"No open bugs found."


dokuwiki-plugins is listed in the bugtracker contribs section.


IDProductVersionStatusSummary
11710SME Contribs10.0CONFIRMEDdokuwiki-plugins change pagemove to move

Categories

Retrieved from "https://wiki.koozali.org/index.php?title=Dokuwiki&oldid=42984"