blob: 2f3c050af3999cf796187db85ec8f30b1070d3dc (
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
# Archweb README
[](https://github.com/archlinux/archweb/actions)
[](https://travis-ci.com/archlinux/archweb)
[](https://coveralls.io/github/archlinux/archweb?branch=master)
To get a pretty version of this document, run
$ markdown README > README.html
# License
See LICENSE file.
# Authors
See AUTHORS file.
# Dependencies
- python
- rsync (optional for mirrorcheck with rsync mirrors)
# 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:
- python-django
- python-psycopg2
- python-markdown
- python-memcached
# Testing Installation
1. Run `python -m venv env`.
cd /path/to/archweb && python -m venv ./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. Migrate changes.
./manage.py migrate
5. 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
6. Use the following commands to start a service instance
./manage.py runserver
7. To optionally populate the database with real data:
wget http://mirrors.kernel.org/archlinux/core/os/x86_64/core.db.tar.gz
./manage.py reporead x86_64 core.db.tar.gz
# Package file listing
wget http://mirrors.kernel.org/archlinux/core/os/x86_64/core.files.tar.gz
./manage.py reporead --filesonly x86_64 core.files.tar.gz
Alter architecture and repo to get x86\_64 and packages from other repos if
needed.
8. Database Updates for Added/Removed packages
sqlite3 archweb.db < packages/sql/update.sqlite3.sql
For PostgreSQL use packages/sql/update.postgresql_psycopg2.sql
# Testing SMTP server
To be able to create an account on your test environment an SMTP server is
required. A simple debugging SMTP server can be setup using Python.
python -m smtpd -n -c DebuggingServer localhost:1025
In local\_settings.py add entries to set EMAIL\_HOST to 'localhost' and EMAIL\_PORT to
1025.
# Running tests and coverage
To the unittests execute the following commands:
./manage.py collectstatic --noinput
./manage.py test
Running coverage:
pip install coverage
coverage run --omit='env*' --source='.' manage.py test
coverage report
# Django Debug toolbar
To use the Django Debug toolbar install django-debug-toolbar and in local_settings.py
set DEBUG_TOOLBAR to True.
# Updating iPXE image
The netboot image can be updated by building the [AUR
package](https://aur.archlinux.org/packages/ipxe-netboot/) (note that it builds
from git master) and copying the resulting ipxe.pxe, ipxe.lkrn and ipxe.efi to
sitestatic/netboot. Then as Arch Linux Developer sign them with your PGP key
```gpg --output ipxe.efi.sig --detach-sig ipxe.efi```.
Testing a build iPXE image requires the 'qemu' package and running the
following command:
qemu-system-x86_64 -kernel ipxe.lkrn -m 2G
# Production Installation
Arch Linux has an Ansible role for Archweb in their [infrastructure repo](https://git.archlinux.org/infrastructure.git/).
vim: set syntax=markdown et:
|
