root/trunk/README

Revision 30, 3.9 KB (checked in by michiel, 15 months ago)

added README file

Line 
1PureUserAdmin %%VERSION%%
2
3Copyright (c) 2007 Michiel van Baak <%%EMAIL%%>
4
5%%HOMEPAGE%%
6
7Licensed under the General Public License (GPL), see COPYING file
8provided with this program.
9
10Contents
11-------------------------------------------------------------------------------
12
13        1. About
14        2. Requirements
15        3. Installation
16                3.1 CherryPy standalone server
17                3.2 mod_python
18        4. Contribute
19        5. Copyright
20        6. Contact
21
221. About
23-------------------------------------------------------------------------------
24        PureUserAdmin is a python application to manage virtual users in a MySQL
25        database for the Pure-FTPd ftp server.
26
272. Requirements
28-------------------------------------------------------------------------------
29        * Python 2.3 or newer
30        * python cherrypy 3.0 or newer
31        * python sqlalchemy 0.3.10 or newer
32        * python mako 0.1.9 or newer
33
34        PureUserAdmin is developed on:
35        * Debian lenny/testing
36        * Python 2.4.4 (debian testing package python)
37        * python cherrypy 3.0.2-1 (debian testing package python-cherrypy3)
38        * python sqlalchemy 0.3.10-1 (debian testing package python-sqlalchemy)
39        * python mako 0.1.9-1 (debain testing package python-mako)
40
413. Installation
42-------------------------------------------------------------------------------
43        Right now there are no packages available yet.
44        To install PureUserAdmin you will have to do a subversion checkout.
45        If you want your tree to be ready for future subversion updates do:
46        svn co https://svn.three-dimensional.net/pureuseradmin/trunk pua-trunk
47        If you want a static checkout without the .svn meta directories do:
48        svn export https://svn.three-dimensional.net/pureuseradmin/trunk pua-trunk
49
50        In both cases you will get warnings about the certificate.
51        For now the certificate is signed for the hostname '*' and is not signed by any CA.
52        If time and money is good we will create a real certificate that's signed by a real CA.
53
54        3.1 CherryPy standalone server
55        ---------------------------------------------------------------------------
56                In the pua.ini file you need to comment out/remove the pua.root_dir line.
57
58        3.2 mod_python
59        ---------------------------------------------------------------------------
60                More info will be here soon, including apache2+mod_python information.
61
624. Contribute
63-------------------------------------------------------------------------------
64        If you have made code to make PureUserAdmin better or fixed bugs please
65        provide patches against the current svn trunk.
66        Make sure you use tabs to ident code. (NO spaces)
67        Code patches can be uploaded to the ticket system on %%HOMEPAGE%%
68        If you don't have an account use the following guest login information:
69        username: guest
70        password: guest
71        With this username/password you will also be able to alter/create wiki pages.
72        Documentation is always something we need help with so if you have some suggestions
73        please feel free to update the wiki.
74
755. Copyright
76-------------------------------------------------------------------------------
77        PureUserAdmin is Copyright by Michiel van Baak,
78        Licensed under the General Public License (GPL)
79
80        Copyright (c), 2007 by Michiel van Baak <%%EMAIL%%>
81
82        This program is free software: you can redistribute it and/or modify
83        it under the terms of the GNU General Public License as published by
84        the Free Software Foundation, either version 3 of the License, or
85        (at your option) any later version.
86
87        This program is distributed in the hope that it will be useful,
88        but WITHOUT ANY WARRANTY; without even the implied warranty of
89        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
90        GNU General Public License for more details.
91
92        You should have received a copy of the GNU General Public License
93        along with This program.  If not, see <http://www.gnu.org/licenses/>.
94
956. Contact
96-------------------------------------------------------------------------------
97        Author:
98                Michiel van Baak
99                Email: %%EMAIL%%
100                Homepage: %%HOMEPAGE%%
101       
102        Please report any bugs, request and general comments on the project page
103        which can be found at %%HOMEPAGE%%
Note: See TracBrowser for help on using the browser.