ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / forum / multi-user_setup_of_ikiwiki__44___gitosis_and_apache2_in_Debian_Sid.mdwn
1 Dear developers and users,
2
3
4 # Problem
5
6 I am trying to set up ikiwiki for a website. Users should be able to edit pages using the webbrowser (ikiwiki.cgi) and a few should be able to edit it using versioning control and in this case Git.
7
8 I have ikiwiki working for a single user (me), but I do not [[get_the_permissions_right|/rcs/Git]] for multiple users and commiters. The wiki admin does not own the Git repository in this case. And I do not understand everything yet (especially concerning wrappers).
9
10 # Programs
11
12 I am running Debian Etch with gitosis (0.2+20080626-2) installed from etch-backports, Apache2 (apache2.2-common 2.2.3-4+etch5) and ikiwiki (2.63) from Sid.
13
14 # Goal
15
16 * The website (run by ikiwiki) should be accessable via http://www.example.org/
17 * Users can edit pages using the webbrowser.
18 * Git is used as the backend.
19 * The Git repository should be publicaly browsable via http://git.example.org/git/project.git (gitweb).
20 * The Git repository can be accessed with git clone git://git.example.org/git/project.git (git-daemon).
21 * Some manually set up users can push their changes over SSH to the repository and the post-update hook updates the wiki.
22
23 # Directory Layout and permissions.
24
25 ## Website
26
27 The website is stored in /srv/www/www.example.org/htdocs/ (destdir in ikiwiki.setup) and is owned by www-data:root with rights 755.
28
29 ## Git repository
30
31 The [package gitosis](http://joey.kitenet.net/blog/entry/locking_down_ssh_authorized_keys/) creates an user gitosis with the home directory /srv/gitosis/ and the repository are stored in /srv/gitosis/repository/project.git owned by gitosis:gitosis and permissions 750. I can setup the permissions who is allowed to access this repository and if it should be published using git-daemon or gitweb in the configuration file gitosis.conf.
32
33 # My efforts without results
34
35 I could not come up with a working set of users which are put into different groups to create a good result with ikiwiki. The main problem is that under Debian umask is set to 022 which means that the members of a group are not allowed to write. I did not want to change this.
36
37 > You can set the umask for ikiwiki itself, without changing the system umask, via the usmask setting in the setup file. --[[Joey]]
38
39 In the end, I did the following. I created a directory /srv/ikiwiki/ which is owned by gitosis. The [[setup_file|/usage]] is also located there (/srv/ikiwiki/project.setup). I put the srcdir there too (srcdir => '/srv/ikiwiki/project/'). So now sudo -u gitosis ikiwiki --project.setup is able to create the post-update hook (git_wrapper => '/srv/gitosis/repositories/project.git/hooks/post-update'). Since this hook is called every time something is checked in over SSH, it is run by gitosis, so I did not set it suid. Or do I have to, because ikiwiki.cgi will be run as www-data?
40
41 > Generally, ikiwiki.cgi is run as the user who owns the wiki and repository, in this case, gitosis. The ikwiiki.cgi needs to be able to write to source files in the wiki; it needs to be able to commit changes,
42 > and it needs to be able to generate and write the html files. If you don't want ikiwiki.cgi to run as gitosis, you will need to put gitosis and www-data in a group and give them both write access, with appropriate umask, etc. --[[Joey]]
43
44 ## cgi_wrapper
45
46 I do not understand those wrappers completely. The cgi is a script, which can be called by a webserver, e. g. [[Apache_2|/tips/dot_cgi]]. But www-data is normally not allowed to write to the source directory (which is owned by gitosis or push to the repository). Therefore it should be run as the user gitosis. And because cgi scripts can not be made suid, I wrapper (in this case a C program) is created (cgi\_wrapper) which can be made suid and therefore be run as the user gitosis. Is this correct?
47
48 > It seems to me like you understand the wrapper pretty well. It's main reson to exist is to safely be suid, yes.
49
50 So where is good place to save this wrapper? cgi_wrapper => '/srv/ikiwiki/project-wrapper'? Then /srv/ikiwiki/project-wrapper is created from a temporary C file prject-wrapper.c?
51
52
53 No sudo -u gitosis ikikwiki --setup project.setup is still not able to put the compilation result into /srv/www/www.project.org/htdocs because this is owned by www-data. I just came up with two things.
54
55 1. Set destdir => '/srv/ikiwiki/html-project', do ln -s /srv/ikiwiki/html-project /srv/www/www.example.org/htdocs and adduser www-data gitosis. But I am not sure about the security implications of using symbolic links.
56
57 2. Since the webserver (Apache 2) has just to read the html files (is that true for static and dynamic (PHP) pages) sudo chown -R gitosis:www-data /srv/www/www.example.org/ should do it. But it is per default www-data:root under Debian, so I do not know if this should be changed.
58
59
60 Could you please enlighten me. It should be possible seeing for example this site.
61
62 > www-data is not really intended to own files. So that if the web server is compromised, it cannot rewrite your web site. So make the site's destdir be owned by the same user that ikiwiki runs as.
63 > /srv/www is not shipped by debian; it is a bug in debian for any package to make files owned by www-data; so it seems to me that your /srv/www www-data ownership is something you must have configured yourself. --[[Joey]]
64
65 Thanks in advance,
66
67 --[[PaulePanter]]
68
69 ---
70
71 ## Current Working Notes
72
73 I've spent a little time getting this working and I wanted to share my notes on this, for those that come after me. 
74
75 ### My Setup 
76
77 - Debian Lenny
78
79 - Gitosis (hand compiled, for no good reason, but it's the same version as in the repository) 
80
81 - Ikiwiki 3.12 installed using packages from Sid
82
83 ### What Works
84
85 - Everything needs to be chowned git:git (or gitosis:gitosis) by whatever gitosis runs with. This includes: 
86   - the bare repository (as always)
87   - the srcdir
88   - the destdir
89
90 - Ikiwiki needs to run in gitosis' group (eg. git in my case, but probably gitosis in yours) 
91
92 - ikiwiki.cgi needs be set with the wrapper mode 6755. 
93
94 -- [[tychoish]]
95
96