README.rst 1.79 KB
Newer Older
Seblu's avatar
Seblu committed
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
======
AURBOT
======

INTRODUCTION
============

*Aurbot* is a AUR [#]_ (Arch Linux Repository) automatic builder of packages.
Its goal is to track updates of AUR packages to build new versions, send mail
report and push the new package inside a binary repository.


*Aurbot* is piloted by its command line tools *aurbot* and timed action, like
rebuild or mail report should be done via cron.

*Aurbot* is written in Python 3.2.


DEPENDENCIES
============
- Python 3.2 [#]_
- pyalpm [#]_
- python-aur [#]_


SECURITY
========
You must take in consideration that *Aurbot* build, so execute, code (PKGBUILD)
from a remote location (AUR), pushed by users from Internet.

Package are built in a clean chroot environment, but this is not an true
security feature as explain in `man (2) chroot`.

So you should automatically build package from user you trust. At least a
little.

To avoid kind of issue *Aurbot* doesn't automatically build new package version
if owner of package if orphan or have changed from the previous build.


QUICK SETUP
===========
1. Install aurbot package
2. Create your repositories configuration
3. Init your repositories
4. Run aurbot


Seblu's avatar
Seblu committed
49
50
51
52
ENVIRONMENT
===========
*AURBOT_CONFIG* overrides the config file path (default is /etc/aurbot.conf)

Seblu's avatar
Seblu committed
53
54
*AURBOT_DATADIR* overrides the data directory path (default is /var/lib/aurbot)

Seblu's avatar
Seblu committed
55

Seblu's avatar
Seblu committed
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
SOURCES
=======
*Aurbot* sources are available on github [#]_.


LICENSE
=======
*Aubot* is licensied under the term of GPL v2 [#]_.


AUTHOR
======
*Aurbot* is developped by Sébastien Luttringer.


LINKS
=====
.. [#] https://aur.archlinux.org/
.. [#] http://python.org/download/releases/
.. [#] http://projects.archlinux.org/users/remy/pyalpm.git/
.. [#] http://xyne.archlinux.ca/projects/python3-aur/
.. [#] https://github.com/seblu/aurbot/
.. [#] http://www.gnu.org/licenses/gpl-2.0.html