summaryrefslogtreecommitdiffstats
path: root/wiki/src/contribute/build/website.mdwn
blob: 44f022e2a32fc8542f57ce00831101abc9be6b44 (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
[[!meta title="Build a local copy of the website"]]

The website [[https://tails.boum.org/]] is built using
[Ikiwiki](https://ikiwiki.info) from source code that is available in
our main Git repository, along with the rest of the Tails code.

You can build a local copy of the website on your computer. Building the
website produces a set a HTML pages stored on your system that you can
open in your usual web browser even while working offline. Doing so is
useful for documentation writers and translators to see how their
changes will apply on the website.

[[!toc]]

Build the website in Linux
==========================

1. Update the list of available packages:

        sudo apt update

2. Install the required packages:

        sudo apt install \
           ikiwiki \
           libyaml-perl \
           libyaml-libyaml-perl \
           libyaml-syck-perl \
           perlmagick \
           po4a \
           ruby

   You need to install ikiwiki version 3.20170111~bpo8+1 or newer.
   In Debian this version is currently available in Stretch and
   jessie-backports.

3. Clone our main [[Git repository|git]]:

        git clone https://git-tails.immerda.ch/tails

[[!inline pages="contribute/build/website/src.inline" raw="yes" sort="age"]]

4. Build the website:

        cd tails && \
        ./build-website

[[!inline pages="contribute/build/website/languages.inline" raw="yes" sort="age"]]

5. You can now browse your local copy of the website in the following folder:

   <span class="filename">config/chroot_local-includes/usr/share/doc/tails/website/</span>

<a id="tails"></a>

Build the website in Tails
==========================

1. [[Create and configure|doc/first_steps/persistence/configure]] a persistent volume and activate the following features:

   - Personal Data
   - APT Packages
   - APT Lists

2. Restart Tails, [[enable the persistence|doc/first_steps/persistence/use]], and [[set up an administration password|doc/first_steps/startup_options/administration_password]].

3. Update the list of available packages:

        sudo apt update

4. Install the required packages:

        sudo apt install \
           ikiwiki \
           libyaml-perl \
           libyaml-libyaml-perl \
           libyaml-syck-perl \
           perlmagick \
           po4a \
           ruby

5. Clone our main [[Git repository|git]] in the <span class="filename">Persistent</span> folder:

        cd ~/Persistent/ && \
        git clone https://git-tails.immerda.ch/tails

[[!inline pages="contribute/build/website/src.inline" raw="yes" sort="age"]]

6. Build the website:

        cd tails && \
        ./build-website --set destdir="/home/amnesia/Persistent/Tor Browser/tails" "$@"

[[!inline pages="contribute/build/website/languages.inline" raw="yes" sort="age"]]

7. You can now visit the following link in <span class="application">Tor Browser</span> to browse your local copy of the website:

   [[file:///home/amnesia/Persistent/Tor Browser/tails/index.en.html]]