A simple wiki engine written in Perl. No database required. https://oddmuse.org/

Alex Schroeder cd9246ebed Add Cooklang extension 1 month ago
contrib 58ecb96975 Add UplinkedIntelligence 3 years ago
css 00af1aa638 New CSS 2 months ago
logo 864890c168 Added logo previews 3 years ago
modules cd9246ebed Add Cooklang extension 1 month ago
scripts 4d10ef389a Add script/unsusbscribe.pl 4 months ago
stuff ceb4c3a9cc Release process: master → main 2 months ago
t f7b23d854f ban-contributors: test Net::IP use 2 months ago
.gitattributes e4d159307b Add .gitattributes 4 years ago
.gitignore 80a30a9102 ignore TAGS 4 years ago
.htaccess 905ba06b0f *** empty log message *** 18 years ago
FDL 2bd43a5d53 Replacement for COPYING file, plus start of a default page. 18 years ago
GPL 214bda4262 Update to GPLv3. 14 years ago
LICENSE 8139036d82 Initial commit 6 years ago
Makefile b514ea7846 Fix TRANSLATIONS glob in the Makefile 4 months ago
README.creole a7625b35f4 README: mention problem with non-existing $DataDir 3 years ago
description 2537a97900 description: added for gitweb. 7 years ago
server.pl 76b433c1da Perl 5.26 no longer adds . to @INC 4 years ago
wiki.pl 4f69103b8c wiki: simplify a regular expression 8 months ago


This is the README file distributed together with the
[[https://oddmuse.org/|Oddmuse]] script.

== Installing Oddmuse on a Debian System running Apache

The following instructions require a number of tools. You can make sure
they're all installed by issuing the following command as {{{root}}}:

apt-get install coreutils apache2 sudo wget w3m perl \
libwww-perl libxml-rss-perl diffutils

You probably created an account for yourself. You might have to add this
user to the {{{sudo}}} group. Here's how I created my own user as

adduser alex
usermod -a -G sudo alex

Now you can login as {{{alex}}} and do everything else using {{{sudo}}}.

You need to copy wiki.pl into your cgi-bin directory, and you need to
make the script executable. You might also have to change its owner to
an appropriate user on your system.

sudo wget -O /usr/lib/cgi-bin/wiki.pl \
sudo chmod +x /usr/lib/cgi-bin/wiki.pl
sudo chown www-data.www-data /usr/lib/cgi-bin/wiki.pl

If you're on SUSE, the user might not be {{{www-data}}} but
{{{wwwrun}}} without appropriate group:

sudo chown wwwrun.root /usr/lib/cgi-bin/wiki.pl

You should be able to test it right now! Visit
{{{http://localhost/cgi-bin/wiki.pl}}}. If your site is available from
the outside, you will be able to use a normal browser. If don't have a
domain name yet, you'll probably have to use a text browser like

w3m http://localhost/cgi-bin/wiki.pl

If you create pages in this wiki, these will get stored in a temporary
directory. You need change the data directory from {{{"/tmp/oddmuse"}}}
to like {{{"/var/local/oddmuse"}}}. The best way to do this without
changing {{{wiki.pl}}} is by editing
{{{/etc/apache2/sites-available/default}}}. Add the following line:

SetEnv WikiDataDir /var/local/oddmuse

Enable the default site by calling the following command:

sudo a2ensite default

Reload the Apache configuration by calling the following command:

sudo service apache2 reload

You need to create the new data directory. You webserver runs CGI
scripts as {{{www-data}}}. Thus, you need to change the owner and group
of the directory to {{{www-data}}}.

sudo mkdir -p /var/local/oddmuse
sudo chown www-data.www-data /var/local/oddmuse

Done! Visit your wiki and start editing. Click on the edit link (the
first link below the navigation bar, at the bottom of the page). This
will allow you to enter some text for this page. Click the Save button
and you are done.

To add new pages, edit the homepage and add links to new pages by
putting their names in {{{[[double square brackets]]}}}.

Enjoy your wiki experience.

Visit https://www.oddmuse.org/ to learn more about the translation
files and modules that are part of this package.

== Checking the Apache Setup

If you think this information doesn't work for you, here are some things
to check.

Apache's config directory is {{{/etc/apache2/apache2.conf}}}. This is
where we get the {{{www-data}}} username from. It says:

# These need to be set in /etc/apache2/envvars

Checking {{{/etc/apache2/envvars}}} we see the following:

export APACHE_RUN_USER=www-data
export APACHE_RUN_GROUP=www-data

So that's what we're using in the {{{chown}}} command in our
instructions above.

The default site is configured in
{{{/etc/apache2/sites-available/default}}}. In order for it to be
//enabled//, there must be a symlink from a file in
{{{/etc/apache2/sites-enabled}}} to the file in
{{{sites-available}}}. You can enable it using the following command:

sudo a2ensite default

This file also lists the directories we've used in our instructions

ScriptAlias /cgi-bin/ /usr/lib/cgi-bin/

This means that {{{http://localhost/cgi-bin/wiki.pl}}} will call

Don't forget to reload the Apache configuration as shown above, or
simply restart it all:

sudo service apache2 graceful

== Using just Perl

You can use Mojolicious as your web server. There is a simple
##server.pl## which you can use. Here's how you might start it:

mkdir ~/oddmuse
WikiDataDir=$HOME/oddmuse perl server.pl daemon

This makes the server available on {{{http://localhost:3000/wiki}}}.
Make sure you create the directory before starting the server!
If you don't, you'll get a strange error:
`STDERR: : No such file or directory at ... perl5/Mojolicious/Plugin/CGI.pm`.

If it works, feel free to upgrade to Hypnotoad.

WikiDataDir=$HOME/oddmuse hypnotoad server.pl

Note: Hypnotoad uses a different default port. The above makes the
server available on {{{http://localhost:8080/wiki}}}. Hypnotoad will
keep forking new processes. To stop it, use the {{{-s}}} flag.

hypnotoad -s server.pl

== License

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at
your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
General Public License for more details.

Both the GNU Free Documentation License, and the GNU General Public
License are distributed together with this script. See the files
[[https://github.com/kensanata/oddmuse/blob/master/FDL|FDL]] and