Tails

#2 Updated by intrigeri 2015-03-05 12:23:33

Good idea.

> I personally use a custom ikiwiki-local.setup file […]

Suggestion: document that this file must be kept synchronized with the official one.

#4 Updated by intrigeri 2015-03-17 12:25:49

> If you think that cloning the repo in Persistent/Tor Browser is not a security issue,

• read access: all the data in that Git repo is supposedly public, so that’s not a problem;
• write access: Tor Browser could e.g. rewrite Git history or add to it before one pushes to the official repo; I’d rather avoid giving the commit bit to Tor Browser.

A safer alternative, that avoids having to maintain a forked ikiwiki.setup, would be to pass --set destdir="~/Persistent/Tor Browser/whatever_you_want" (or the same without Persistent/) to build-wiki. For easier usage, one can even create their own my-build-wiki script, that just wraps build-wiki and passes this additional option. This should work:

#!/bin/sh
./build-wiki --set destdir="~/Tor Browser/whatever_you_want" "$@"

We could even ship such a script, with a fixed destdir in ~/Tor Browser/, somewhere in our Git repo (preferably in a bin or scripts sub-directory, since IMO we should stop cluttering the top-level directory with such things).

#7 Updated by intrigeri 2015-03-19 14:17:59

> Your snippet creates a dangerous ‘~’ directory in the curent directory. Damn it!

Sorry about that :(

> I tried other versions but couldn’t escape correctly the space in the path:

> - destdir="~/Tor Browser/tails" builds in “~”
> - destdir="/home/amnesia/Tor Browser/tails" builds in /home/amnesia/Tor, so does destdir='/home/amnesia/Tor Browser/tails'
> - destdir="/home/amnesia/Tor\ Browser/tails" builds in /home/amnesia/Tor\

This is clearly a bug in ikiwiki. Has it been reported yet?

I’ve verified that one can workaround this bug locally by pointing destdir to a symlink whose name doesn’t contain spaces, and that itself points to the real destdir (with spaces in its name).

#9 Updated by sajolida 2015-04-05 16:16:46

Actually, this command works as expected:

ikiwiki --setup ikiwiki.setup --set destdir="/home/amnesia/Persistent/Tor Browser/tails" --rebuild

So, I’m not sure that this is a bug in ikiwiki but maybe rather in your bash escaping.

Anyway, a better scenario for step 3 and 4 could be:

3. Clone the Git repo in ~/Persistent:

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

4. Build the wiki in ~/Persistent/Tor Browser:

ikiwiki —setup ikiwiki.setup —set destdir=“/home/amnesia/Persistent/Tor Browser/tails” —refresh

5. Visit file:///home/amnesia/Persistent/Tor Browser/tails/index.en.html.

#10 Updated by intrigeri 2015-04-06 09:02:33

> Actually, this command works as expected:

> ikiwiki --setup ikiwiki.setup --set destdir="/home/amnesia/Persistent/Tor Browser/tails" --rebuild

Good news! We’ve got a solution then :)

> So, I’m not sure that this is a bug in ikiwiki but maybe rather in your bash escaping.

I don’t understand what you mean: after you reported that various other commands didn’t work for you, you’ve now tested the implementation I’ve suggested in Feature #9018#note-4 and are reporting that it works => I don’t get what it has to do with my bash escaping.

Anyhow: indeed there’s no bug there in ikiwiki (my bad), since passing -destdir as you did in Feature #9018#note-6 isn’t documented => no big surprise it didn’t work.

> Anyway, a better scenario for step 3 and 4 could be:

> 3. Clone the Git repo in ~/Persistent:

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

Perhaps instead cd ~/Persistent && git clone https://git-tails.immerda.ch/tails?

> 4. Build the wiki in ~/Persistent/Tor Browser:

> ikiwiki —setup ikiwiki.setup —set destdir=“/home/amnesia/Persistent/Tor Browser/tails” —refresh

I don’t understand why you’re insisting on not using build-wiki here. IMO it’s a useful wrapper, that gives us the flexibility to add/change default command-line options in a way that applies to everyone who’s building the website locally. Experts who want to use a custom local ikiwiki.setup etc. can still do it themselves, but IMO that’s not what we should document for the masses of contributors. Sadly, build-wiki’s current implementation lacks some quoting in the way it handles additional arguments, which breaks this use case. This is fixed for me here with this patch:

--- a/build-wiki
+++ b/build-wiki
@@ -1,3 +1,3 @@
 #!/bin/sh

-ikiwiki -setup ikiwiki.setup -refresh ${@}
+ikiwiki --setup ikiwiki.setup --refresh "$@"

> 5. Visit file:///home/amnesia/Persistent/Tor Browser/tails/index.en.html.

ACK.

#11 Updated by sajolida 2015-04-06 15:20:42

> I don’t understand what you mean: after you reported that various other commands didn’t work for you, you’ve now tested the implementation I’ve suggested in Feature #9018#note-4 and are reporting that it works => I don’t get what it has to do with my bash escaping.

In Feature #9018#note-4 you suggested using ./build-wiki and that’s what didn’t work. Replacing it with ikiwiki --setup ikiwiki.setup works. It had to do with the bash in ./build-wiki actually.

See:

$ bash -x ./build-wiki --set destdir="~/Tor Browser/tails" "$@"
+ ikiwiki -setup ikiwiki.setup -refresh --set 'destdir=~/Tor'  Browser/tails

> I don’t understand why you’re insisting on not using build-wiki here.

Because your snippet didn’t work and mine did!

> This is fixed for me here with this patch

That still doesn’t work. See:

$ bash -x ./build-wiki --set destdir="~/Tor Browser/whatever_you_want" "$@"
+ ikiwiki -setup ikiwiki.setup -refresh --set 'destdir=~/Tor Browser/whatever_you_want'

Which creates a ‘_{’ directory again. So is there a bug in ikiwiki for badly interpreting ’}’?

But it works with this command and your patch:

./build-wiki --set destdir="/home/amnesia/Tor Browser/tails" "$@"

Which should make everybody happy at last.

I’ll submit a branch for your patch on build-wiki, see Bug #9162.

#12 Updated by intrigeri 2015-04-06 15:38:27

>> I don’t understand why you’re insisting on not using build-wiki here.

> Because your snippet didn’t work and mine did!

Fair enough. Sorry.

> That still doesn’t work. See:

>

> $ bash -x ./build-wiki --set destdir="~/Tor Browser/whatever_you_want" "$@"
> + ikiwiki -setup ikiwiki.setup -refresh --set 'destdir=~/Tor Browser/whatever_you_want'
> 

> Which creates a ‘_{’ directory again. So is there a bug in ikiwiki for badly interpreting ’}’?

FYI, in general applications do not interpret ‘~’: it’s the shell’s duty to do so before it passes arguments to the command it runs. With this in mind, what your example shows is that bash doesn’t interpret it when it’s between double-quotes.

Unrelated note: using an interpreter (bash), to debug a script, that’s not the one that’s going to be used to run it in practice (/bin/sh), may surprise you in painful ways in the future. Better avoid this, especially if you’re not interested in learning the differences between bashisms and POSIX shell :)

> But it works with this command and your patch:

>

> ./build-wiki --set destdir="/home/amnesia/Tor Browser/tails" "$@"
> 

Yay!

#14 Updated by sajolida 2015-04-07 15:28:19

DS, please base your work on wiki/src/contribute/build/website.mdwn in the Git repo, and integrate what I mentioned in the description of this ticket (additional packages required to build the wiki in Tails) and the steps from notes #3 and #9. And the final command we agreed upon from note #11 (for step 4).

Don’t hesitate to ask for clarification or submit a summarized synopsis first.

#15 Updated by DS 2015-04-08 06:40:05

> Don’t hesitate to ask for clarification or submit a summarized
> synopsis first.

Indeed I need some clarification. I must be lacking some basic
fundamentals because I’m feeling rather stupid reading 9018.

To begin wiith I don’t understad what this notation means:
I put in them ikiwiki

But that;s just the beginning, Feature #9018 seems to me to consist of partial
bits of conversations with ineterim pieces completely missing.

Let me pick apart just this one section, starting and ending with
, but unfortunatkey it seems I can’t format any of my comments
so that you’ll know I’m commenting! My comments in * comment *

Updated by sajolida 1 day ago

I don’t understand what you mean *I have no idea what this is in
reference to * : after you * who? * reported that various other
commands didn’t work for you, you’ve now tested the implementation
I’ve suggested in Feature #9018#note-4 and are reporting that it works => I
don’t get what it has to do with my bash escaping * I don’t know
what “bash escaping” is *.

In Feature #9018#note-4 you suggested using ./build-wiki * ./build-wiki I
understand to be a commnad, because I used it * and that’s what didn’t
work * It didn’t work? *. Replacing it with ikiwiki —setup
ikiwiki.setup works * ikiwiki —setup
ikiwiki.setup is a command? *. It had to do with the bash
in ./build-wiki actually.

I think the limitation of this email client can make effective
commuunication impossible.

Is this (below) one command?

ikiwiki —setup ikiwiki.setup —set
destdir=“/home/amnesia/Persistent/Tor Browser/tails” —rebuild

When I input that on the command line, the system reponds with (as
expected):

bash: ikiwiki: command not found

I’m sorry, but coming from the outside I have no idea who’s talking to
who in the dialog of 9018.

DS

#16 Updated by intrigeri 2015-04-08 09:14:31

> I’m sorry, but coming from the outside I have no idea who’s talking to who in the dialog of 9018.

Perhaps looking at the discussion via the web interface (https://labs.riseup.net/code/issues/9018) would help?

#17 Updated by sajolida 2015-04-08 18:00:39

Yes, you can either answer to the email notifications by email (maybe check the syntax first: https://labs.riseup.net/code/help/en/wiki_syntax.html) or comment using the web interface.

Executing the command ‘ikiwiki’ doesn’t work because you’re probably confused about step 2. When I say “put ‘ikiwiki’ in the list of additional software packages”, I mean that you need to edit the file ‘/live/persistence/TailsData_unlocked/live-additional-software.conf’ and put ‘ikiwiki’ as a line in there. See the documentation of this feature https://tails.boum.org/doc/first_steps/persistence/configure#index14h2

To edit files as an administrator your can for example:

1. Set an administration password
2. Choose Appliations -> Accessories -> Root Terminal
3. Execute:

gedit /doc/first_steps/persistence/configure#index14h2

Then list the packages mentioned in note #3, save the file, and restart Tails. Then you should have ikiwiki installed.

The verify that a package is installed you can execute

dpkg -l ikiwiki

and “ii” at the beginning of the line means that the package is installed.

#20 Updated by sajolida 2015-04-09 14:54:16

> Done, and it is now installed.

Victory!

> It’s installed. Now what?

I explained you this because I felt that you were lacking background
knowledge to understand better what was in my note #3.

But as I understand that this is still very confusing to you, I updated
the description of the ticket with our latest version of the steps. Make
sure to read it again and understand the logic behind them.

So now you should go back to those steps and add the other packages
described in step 2 to your additional software packages (namely po4a,
imagemagick, and perlmagick) which are required to compile our website
using ikiwiki.

> I went to the ikiwiki site and read about installing it.
>
> https://ikiwiki.info/setup/
>
> I did a:
>
> ikiwiki —setup /etc/ikiwiki/auto.setup
>
> probably shouldn’t have done that.

I see from your screenshots that ikiwiki is installed all-right so you
don’t have do do anything of this. Here is the thing:

• ikiwiki will be reinstalled automatically on each boot from now on
  thanks to the additional software packages feature.
• You have (or will have) our source files for ikiwiki in your copy of
  the Git repo (under wiki/src). That’s our step 3 (in case you don’t
  have this already).
• The build-wiki command that we finally agreed upon for step 4 will
  build the source into HTML pages.

Once you did step 2, go on and try step 3, then step 4.

#21 Updated by DS 2015-04-11 07:40:37

Ok, everything works up until 5 (below)
>
> 5. Visit and bookmark
>
> <file:///home/amnesia/Persistent/Tor Browser/tails/>
>
Nothing appears in the browser with the above path.

#22 Updated by DS 2015-04-11 20:38:55

It seems to me that everything is in order per the instructions.

Step 1 is simply enableing those applications during the Persistent volume setup, which I did. And have checked with Configarure Persistent volume - all are checked green.

Step 2 and 3 have been done, as can be witnessed by the fact that step 4 works:

root@amnesia:/home/amnesia/Persistent/tails# ./build-wiki —set destdir=“/home/amnesia/Tor Browser/tails” “$@”
refreshing wiki..
done

So, I’m uncertain what my problem is…? I would suspect (and will investigate) that this is incorrect:

—set destdir=“/home/amnesia/Tor Browser/tails” “$@”

#24 Updated by sajolida 2015-04-14 17:27:23

> —set destdir=“/home/amnesia/Tor Browser/tails” “$@”

Yes, I think that you found a mistake in my previous instructions.

The wiki needs to be built in /home/amnesia/Persistent/Tor Browser/tails to be saved in the persistent volume.

I updated the description of the ticket accordingly (step 4).

Sorry for the silly mistake. But you’re almost there!

#25 Updated by DS 2015-04-17 07:15:23

On Tue, 14 Apr 2015 17:18:25 +0000
redmine@labs.riseup.net wrote:

> Issue Feature #9018 has been updated by sajolida.
>
> Description updated
>
> ————————————————————
> Feature Feature #9018: Document how to build the wiki in Tails
> https://labs.riseup.net/code/issues/9018#change-36293
>
> * Author: sajolida
> * Status: Confirmed
> * Priority: Normal
> * Assignee: DS
> * Category:
> * Target version:
> * QA Check:
> * Feature Branch:
> * Type of work: Contributors documentation
> * Blueprint:
> * Easy: Yes
> * Affected tool:
> ————————————————————
> We already have a documentation about building the website here
> https://tails.boum.org/contribute/build/website but it is not
> suitable for Tails. On top of that we would explain:
>
> If you think that cloning the repo in Persistent/Tor Browser is not a
> security issue, then we could do without a dedicated ikiwiki.setup
> file. For example:
>
> 1. Activate some relevant persistence features:
>
> * Personal Data
> * APT Packages
> * APT Lists
> * Bookmarks
>
> 2. Configure the needed additional software in persistence:
>
>

> ikiwiki
> po4a
> imagemagick
> perlmagick
> 

>
> 3. Clone the Git repo in Persistent/Tor Browser:
>
>

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

>
> 4. Run build-wiki
>
>

> ./build-wiki --set destdir="/home/amnesia/Persistent/Tor
> Browser/tails" "$@" 

Still not quite right:
root@amnesia:/home/amnesia/Persistent/tails# ./build-wiki —set
destdir=“/home/amnesia/Persistent/tails” “$@” refreshing wiki..
done

At least the path above is the only place I have build-wiki.

Unless
you’re trying to uupdate the tails folder with the X and lock icon on
it in Home > Persistent > Tor Browser > tails

Which I guess is what we’re trying to do, in which case I get:

root@amnesia:/home/amnesia# cd Persistent/“Tor Browser”/tails
root@amnesia:/home/amnesia/Persistent/Tor Browser/tails# ./build-wiki
—set destdir=“/home/amnesia/Persistent/Tor Browser/tails” "$" bash: ./build-wiki: No such file or directory rootamnesia:/home/amnesia/Persistent/Tor Browser/tails#

Soooooo……..???

8-)

>
> 5. Visit and bookmark
>
> <file:///home/amnesia/Persistent/Tor Browser/tails/>
>
> With all that information, I’m marking this as easy as this could be
> a nice first contribution to our documentation while fixing your own
> setup :)
>
> —-Files————————————————
> ikiwiki_1.png (107 KB)
> ikiwiki_2.png (123 KB)
>
>

#26 Updated by sajolida 2015-04-18 20:04:06

> root@amnesia:/home/amnesia/Persistent/tails# ./build-wiki

If you do this as root, then you won’t be able to open the resulting
website using Tor Browser because of permission problems.

You should instead open a terminal as the amnesia user (from the
shortcuts in the top bar) and run the same command from the same place.
If you get into trouble again, try to remove
/home/amnesia/Persistent/tails and /home/amnesia/Persistent/Tor
Browser/tails as root and start again the whole procedure as the amnesia
user.

> At least the path above is the only place I have build-wiki.

This path is correct.

> root@amnesia:/home/amnesia# cd Persistent/“Tor Browser”/tails
> root@amnesia:/home/amnesia/Persistent/Tor Browser/tails# ./build-wiki
> —set destdir=“/home/amnesia/Persistent/Tor Browser/tails” "$" > bash: ./build-wiki: No such file or directory > rootamnesia:/home/amnesia/Persistent/Tor Browser/tails#
>
> Soooooo……..???

You have to run build-wiki from the folder where it is, which is
/home/amnesia/Persistent/tails.

#27 Updated by okgoogle 2015-06-02 04:24:07

@sajolida, I’m a little confused about the phrasing “if you think is not a security issue” - is there any reason it would be a security issue other than my Persistent Volume becoming compromised because someone determined the passphrase? Any other attack vectors, here that contributors following this process should be aware of?

sajolida wrote:
> If you think that cloning the repo in Persistent/Tor Browser is not a security issue, then we could do without a dedicated ikiwiki.setup file.

#30 Updated by elouann 2015-07-22 16:00:48

A draft was written, and you can review there:

http://git.tails.boum.org/elouann/tails/tree/wiki/src/contribute/build/website.mdwn?h=build-the-wiki-offline-within-tails&id=120ee6d7a5d865ce69f24a0c3cf7609c0a2fac5d

Thank you,
~ elouann

#36 Updated by elouann 2015-08-23 08:51:21

Thanks for the review. I added some commits on top of origin/doc/9018-build-website-in-tails

Please see https://git-tails.immerda.ch/elouann/tails/log/?h=doc/9018-build-website-in-tails