summaryrefslogtreecommitdiff
path: root/README.md
blob: ee3c9cca2293d56fb6d1f668b35a3a5dd32e2055 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# Parabolaweb README

It is recommended that you just install the (Parabola) package
`parabolaweb-utils`, it

 - depends on the dependencies of parabolaweb (that is, don't use
   virtualenv)
 - has a `parabolaweb-update` program that does most of the things here
 - has a `parabolaweb-changepassword` program that allows system users
   to change their parabolaweb password
 - has `/etc/uwsgi/parabolaweb.ini.example`

To run parabolaweb, you can use `./manage testserver` to run a small
HTTP server, or run `systemctl enable --now uwsgi@parabolaweb.socket`,
and stick that behind a proper web server that speaks WSGI (such as
Nginx).

Following is Archweb's readme, as I figure it might be useful for some people,
but I have given up on maintaining it for parabolaweb.

# Archweb README

To get a pretty version of this document, run

    $ markdown README > README.html

# License

See LICENSE file.

# Authors

See AUTHORS file.

# Dependencies

- python2
- python2-virtualenv

# Python dependencies

More detail in `requirements.txt` and `requirements_prod.txt`; it is best to
use virtualenv and pip to handle these. But if you insist on (Arch Linux)
packages, you will probably want the following:

- django
- python2-psycopg2
- python2-markdown
- python2-memcached

# Testing Installation

1. Run `virtualenv2`.

        cd /path/to/archweb && virtualenv2 ./env/

2. Activate the virtualenv.

        source ./env/bin/activate

2. Install dependencies through `pip`.

        pip install -r requirements.txt

3. Copy `local_settings.py.example` to `local_settings.py` and modify.
   Make sure to uncomment the appropriate database section (either sqlite or
   PostgreSQL).

4. Sync the database to create it.

        ./manage.py syncdb

5. Migrate changes.

        ./manage.py migrate

6. Load the fixtures to prepopulate some data. If you don't want some of the
   provided data, adjust the file glob accordingly.

        ./manage.py loaddata main/fixtures/*.json
        ./manage.py loaddata devel/fixtures/*.json
        ./manage.py loaddata mirrors/fixtures/*.json
        ./manage.py loaddata releng/fixtures/*.json

7. Use the following commands to start a service instance

        ./manage.py runserver

8. To optionally populate the database with real data:

        wget http://mirrors.kernel.org/archlinux/core/os/i686/core.db.tar.gz
        ./manage.py reporead i686 core.db.tar.gz
        ./manage.py syncisos

Alter architecture and repo to get x86\_64 and packages from other repos if
needed.

# Production Installation

Ask someone who knows, or you are going to be in trouble.

vim: set syntax=markdown et: