README.md 3.14 KB
Newer Older
1
2
# Archweb README

3
[![Build Status](https://travis-ci.com/archlinux/archweb.svg?branch=master)](https://travis-ci.com/archlinux/archweb)
Angel Velásquez's avatar
Angel Velásquez committed
4
5
[![Coverage Status](https://coveralls.io/repos/github/archlinux/archweb/badge.svg?branch=master)](https://coveralls.io/github/archlinux/archweb?branch=master)

6
7
8
9
10
11
12
13
14
15
16
17
18
19
To get a pretty version of this document, run

    $ markdown README > README.html

# License

See LICENSE file.

# Authors

See AUTHORS file.

# Dependencies

20
21
- python
- python-virtualenv
22
23
24
25
26
27
28

# 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:

29
30
31
32
- python-django
- python-psycopg2
- python-markdown
- python-memcached
33
34
35

# Testing Installation

36
1. Run `virtualenv3`.
37

38
        cd /path/to/archweb && virtualenv3 ./env/
39
40
41

2. Activate the virtualenv.

42
        source ./env/bin/activate
43
44
45

2. Install dependencies through `pip`.

46
        pip install -r requirements.txt
47
48
49
50
51

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

52
4. Migrate changes.
53

54
        ./manage.py migrate
55

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

59
60
61
62
        ./manage.py loaddata main/fixtures/*.json
        ./manage.py loaddata devel/fixtures/*.json
        ./manage.py loaddata mirrors/fixtures/*.json
        ./manage.py loaddata releng/fixtures/*.json
63

64
6. Use the following commands to start a service instance
65

66
        ./manage.py runserver
67

68
7. To optionally populate the database with real data:
69

70
71
72
73
74
        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
75
76
77
78

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

79
80
81
82
83
84
85
8. Database Updates for Added/Removed packages

        sqlite3 archweb.db < packages/sql/update.sqlite3.sql

For PostgreSQL use packages/sql/update.postgresql_psycopg2.sql


86
87
88
89
90
# 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.

91
        python -m smtpd -n -c DebuggingServer localhost:1025
92

93
In local\_settings.py add entries to set EMAIL\_HOST to 'localhost' and EMAIL\_PORT to
94
95
1025.

96
97
98
99
100
101
102
103
104
105
106
107
108
# 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

Jelle van der Waa's avatar
Jelle van der Waa committed
109
110
111
112
# Django Debug toolbar

To use the Django Debug toolbar install django-debug-toolbar and in local_settings.py
set DEBUG_TOOLBAR to True.
113

114
115
# Production Installation

Jelle van der Waa's avatar
Jelle van der Waa committed
116
Arch Linux has an Ansible role for Archweb in their [infrastructure repo](https://git.archlinux.org/infrastructure.git/).
117
118

vim: set syntax=markdown et: