Merge pull request #1068 from AladW/sync-rebuild-tree-prov
[aurutils.git] / man7 / aurhosting.7
blobbd3e9ab85c1d30b6640cbe0693f269fa06f0bebb
1 .TH AURHOSTING 7 2018-02-05 AURUTILS
2 .SH NAME
3 aurhosting \- host pacman repositories using git
5 .SH ADVANTAGES
6 .SS Atomic changesets
8 Each revision can be viewed as a single set of packages. This provides
9 a way for every commit to be an atomic operation allowing for mirrors
10 to synchronize consistently. Each mirror can then make a shallow
11 clone of the repository while still only recovering changed packages
12 reducing bandwidth while maintaining atomicity without additional
13 scripting or tooling.
15 .SS Changeset based roll back
17 Rolling back using changesets is usually done by specifying the commit
18 checksum in the Server directive and allows for rolling back based on
19 changesets rather than needing to manage finely grained version
20 dependencies.
22 .SH DISADVANTAGES
23 .SS Requires raw file access
25 The server hosting the git repository needs a mechanism to expose raw
26 files directly using a simple and consistent layout so that files can
27 be downloaded using dead reckoning.
29 .SH HOSTING TEMPLATES
31 .EX
32 https://cgit/$repo.git/plain/
33 https://gitlab.com/$user/$repo/raw/${commit:\-master}/
34 https://try.gogs.io/$user/$repo/raw/${commit:\-master}/
35 http://repo.or.cz/$repo.git/blob_plain/${commit:\-HEAD}:/
36 https://raw.githubusercontent.com/$user/$repo/${commit:\-master}/
37 .EE
39 .SH EXAMPLES
40 .SS Using github.com
41 .EX
42     % vi pacman.conf
44     [earnestly]
45     SigLevel = PackageOptional
46     Server = https://raw.githubusercontent.com/Earnestly/earnestly/master
48     % repose \-fvzr ~/earnestly earnestly
49     adding stlink\-git 1.3.1.r17.g5c10d4b\-1
50     writing earnestly.db...
51     writing earnestly.files...
53     % sudo pacman \-Syu
54     :: Synchronizing package databases...
55     earnestly        32.7 KiB  0.00B/s 00:00 [\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-] 100%
57     % pacman \-Sl earnestly
58     earnestly stlink\-git 1.3.1.r17.g5c10d4b\-1
60     % sudo pacman \-S stlink\-git
61     resolving dependencies...
62     looking for conflicting packages...
64     Package (1)           New Version           Net Change  Download Size
66     earnestly/stlink\-git  1.3.1.r17.g5c10d4b\-1    0.41 MiB       0.09 MiB
68     Total Download Size:   0.09 MiB
69     Total Installed Size:  0.41 MiB
71     :: Proceed with installation? [Y/n]
72 .EE
74 .SH AUTHORS
75 .MT https://github.com/Earnestly
76 Earnestly
77 .ME