aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README62
1 files changed, 38 insertions, 24 deletions
diff --git a/README b/README
index 60d2358..86f686e 100644
--- a/README
+++ b/README
@@ -27,30 +27,44 @@ For that to work, you, the wiki user and root needs ssh read/write access to the
Usage example
-------------
- # Declare the ikiwiki class
- class { 'ikiwiki':
- www_user => 'www-data',
- sites_folder => /var/www,
- git_implementation => 'gitolite',
- git_folder => '/var/lib/git',
- }
-
- # Define your website using your http server module of choice.
- apache::site { "mywiki":
- docroot => "${apache::sites_folder}/mywiki/ikiwiki",
- use => [ "Ikiwiki mywiki" ],
- owner => 'mywiki',
- group => 'mywiki',
- }
-
- # Define your ikiwiki instance.
- ikiwiki::instance { "mywiki":
- ensure => present,
- description => "My Ikiwiki",
- adminuser => "myuser",
- disable_plugins => "openid",
- add_plugins => "goodstuff sidebar",
- }
+ # Declare the ikiwiki class
+ class { 'ikiwiki':
+ www_user => 'www-data',
+ sites_folder => /var/www,
+ git_implementation => 'gitolite',
+ git_folder => '/var/lib/git',
+ }
+
+ # Define your website using your http server module of choice.
+ apache::site { "mywiki":
+ docroot => "${apache::sites_folder}/mywiki/ikiwiki",
+ use => [ "Ikiwiki mywiki" ],
+ owner => 'mywiki',
+ group => 'mywiki',
+ }
+
+ # Define your ikiwiki instance.
+ ikiwiki::instance { "mywiki":
+ ensure => present,
+ description => "My Ikiwiki",
+ adminuser => "myuser",
+ disable_plugins => "openid",
+ add_plugins => "goodstuff sidebar",
+ }
+
+Example gitolite configuration
+------------------------------
+
+Here we're using one pubkey for the wiki user and another for the server:
+
+ @public = daemon gitweb
+ @mywiki = your@pubkey.org mywiki@pubkey.org root@yourserver.org
+
+ mywiki "Admins" = "My Ikiwiki"
+
+ repo mywiki
+ R = @public
+ RW = @mywiki
References
----------