cryptonas/cryptonas
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

doc update

Browse source
This commit is contained in:
lars 2006-05-15 09:38:36 +00:00
parent b2ce217afe
commit 333f46993c
26 changed files with 763 additions and 540 deletions
Download patch file Download diff file Expand all files Collapse all files

149
doc/html/en/CryptoBox.html
View file

@ -8,35 +8,46 @@
<div class='wiki-toc'>
<h4>Table of Contents</h4>
<ol>
<li><a href="/cryptobox?action=doc&page=CryptoBox#News&weblang=en">News</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBox#Overview&weblang=en">Overview</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBox#Download&weblang=en">Download</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBox#Specs&weblang=en">Specs</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBox#Documentation&weblang=en">Documentation</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBox#Development&weblang=en">Development</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBox#Acknowledgements&weblang=en">Acknowledgements</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBox#Legalstuff&weblang=en">Legal stuff</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBox#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBox&weblang=en#News">News</a></li>
<li><a href="?action=doc&page=CryptoBox&weblang=en#Overview">Overview</a></li>
<li><a href="?action=doc&page=CryptoBox&weblang=en#Specifications">Specifications</a></li>
<li><a href="?action=doc&page=CryptoBox&weblang=en#Download">Download</a></li>
<li><a href="?action=doc&page=CryptoBox&weblang=en#Whatweshare">What we share</a></li>
<li><a href="?action=doc&page=CryptoBox&weblang=en#Whatyoumightshare">What you might share</a></li>
<li><a href="?action=doc&page=CryptoBox&weblang=en#Development">Development</a></li>
<li><a href="?action=doc&page=CryptoBox&weblang=en#Acknowledgements">Acknowledgements</a></li>
<li><a href="?action=doc&page=CryptoBox&weblang=en#Legalstuff">Legal stuff</a></li>
<li><a href="?action=doc&page=CryptoBox&weblang=en#Comments">Comments</a></li>
</ol>
</div>
</p>
<h1 id="TheCryptoBox">The CryptoBox</h1>
<p>
<i><a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">deutsche Version</a></i>
<i><a href="?action=doc&page=CryptoBox&weblang=en">deutschsprachige Version</a></i>
</p>
<h2 id="News">News</h2>
<ul><li>[14/04/02006] Sorry folks, codecoop.org is temporarly down. Update: it's up and running again. Fetch the latest version <a class="ext-link" title="http://codecoop.org/projects/cryptobox/" href="http://codecoop.org/projects/cryptobox/">here</a>
</li><li>[07/03/02006] We're currently splitting the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> up in the CryptoBox-Webfrontend and the Cryptobox-CD. This will let you use the CryptoBox-Webfrontend in your favourite Linux Installation. stay tuned..
</li><li>[30/10/02005] The new <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> version 0.2.1 is available at <a class="ext-link" title="http://codecoop.org/frs/?group_id=60" href="http://codecoop.org/frs/?group_id=60">codecoop.org</a>!
<ul><li><a href="/trac/cryptobox/wiki/ReleaseNotes/0.2.1">release notes</a>
</li></ul></li><li>[21/10/02005] We discovered a bug in v0.2, which in some cases prevents the intialization of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>. Please wait for v0.2.1 to obtain a working release. We recommend not using v0.2 and are very sorry for the inconvenience.
</li><li>[04/10/02005] The first release (v0.2) of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> is available at <a class="ext-link" title="https://codecoop.org/projects/cryptobox/" href="https://codecoop.org/projects/cryptobox/">Codecoop.org</a>.
</li></ul><h2 id="Overview">Overview</h2>
<p>
The first release of the <a href="/cryptobox?action=doc&page=CryptoBox">CryptoBox</a> is available at <a class="ext-link" title="https://codecoop.org/projects/cryptobox/" href="https://codecoop.org/projects/cryptobox/&weblang=en">https://codecoop.org/projects/cryptobox/</a>
The <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> is a Debian/Linux based <a class="ext-link" title="http://en.wikipedia.org/wiki/Live_CD" href="http://en.wikipedia.org/wiki/Live_CD">live-cd</a>. This CD boots up, starting a secure fileserver. Even non-technical users are able to store their data on its encrypted harddisk. There is no special knowledge about <a class="ext-link" title="http://en.wikipedia.org/wiki/Cryptography" href="http://en.wikipedia.org/wiki/Cryptography">cryptography</a> or servers required at all.<br />
The <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> is fully controllable via your web browser. Have a look at the <a href="?action=doc&page=ScreenShots&weblang=en">ScreenShots</a>.
</p>
<h2 id="Overview">Overview</h2>
<p>
The <a href="/cryptobox?action=doc&page=CryptoBox">CryptoBox</a> is a Debian/Linux based <a class="ext-link" title="http://en.wikipedia.org/wiki/Live_CD" href="http://en.wikipedia.org/wiki/Live_CD">live-cd</a>. This CD boots up, starting a secure fileserver. Even non-technical users are able to store their data on its encrypted harddisk. There is no special knowledge about <a class="ext-link" title="http://en.wikipedia.org/wiki/Cryptography" href="http://en.wikipedia.org/wiki/Cryptography&weblang=en">cryptography</a> or servers required at all.
Use the web interface of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> in your favourite language:
</p>
<ul><li>English
</li><li>German
</li><li>Slovenian
</li></ul><h2 id="Specifications">Specifications</h2>
<p>
some rather technical details:
</p>
<h2 id="Download">Download</h2>
<ul><li><a class="ext-link" title="http://codecoop.org/frs/download.php/32/cryptobox_0.2.iso" href="http://codecoop.org/frs/download.php/32/cryptobox_0.2.iso">version 0.2</a> [106 MB] - <a href="/trac/cryptobox/wiki/ReleaseNotes/0.2">Release notes</a>
<ul><li><i>provided by <a class="ext-link" title="http://codecoop.org" href="http://codecoop.org">http://codecoop.org</a></i>
</li></ul></li></ul><h2 id="Specs">Specs</h2>
<table class="wiki">
<tr><td>system</td><td>Debian/Linux based Live-CD
</td></tr><tr><td>needed hardware</td><td> &#34;outdated&#34; PC (i386 p1-100 32MB RAM minimum)
@ -45,33 +56,28 @@ The <a href="/cryptobox?action=doc&page=CryptoBox">CryptoBox</a> is a Debian/Lin
</td></tr><tr><td>userinterface</td><td>fully remote controlled via webbrowser
</td></tr><tr><td>encryption</td><td><a class="ext-link" title="http://en.wikipedia.org/wiki/Advanced_Encryption_Standard" href="http://en.wikipedia.org/wiki/Advanced_Encryption_Standard">AES</a> via device-mapper
</td></tr></table>
<h2 id="Download">Download</h2>
<ul><li>Get the newest version by following <a class="ext-link" title="http://codecoop.org/frs/?group_id=60" href="http://codecoop.org/frs/?group_id=60">this link</a>.
<ul><li><i>kindly provided by <a class="ext-link" title="http://codecoop.org" href="http://codecoop.org">http://codecoop.org</a></i>
</li></ul></li></ul><h2 id="Whatweshare">What we share</h2>
<p>
The web interface of the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> supports the following languages:
We do our best to help you using the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
</p>
<ul><li>English
</li><li>German
</li><li>Slovenian
</li></ul><p>
Feel free to contribute a <a href="/trac/cryptobox/browser/trunk/cbox-tree.d/usr/share/cryptobox/lang/">translation</a> for another language (preferably utf-encoded).
</p>
<h2 id="Documentation">Documentation</h2>
<ul><li>You can find detailed information in the <a href="?action=doc&page=CryptoBoxUser&weblang=en">user manual</a>.
</li><li>For further questions write an email to <i>cryptobox[at]systemausfall.org</i>
</li></ul><h2 id="Whatyoumightshare">What you might share</h2>
<p>
The user documentation has its home at <a href="/cryptobox?action=doc&page=CryptoBoxUser&weblang=en">CryptoBoxUser</a>.
You are not just a consumer. You can help others with your knowledge.
</p>
<h2 id="Development">Development</h2>
<p>
Take a look at the developer's documentation at <a href="/cryptobox?action=doc&page=CryptoBoxDev&weblang=en">CryptoBoxDev</a>.
</p>
<p>
Report bugs to <a class="ext-link" title="https://systemausfall.org/trac/cryptobox/newticket" href="https://systemausfall.org/trac/cryptobox/newticket">https://systemausfall.org/trac/cryptobox/newticket</a>.
</p>
<p>
Browse the <a href="/trac/cryptobox/browser/">source code</a>.
</p>
<p>
Anything else? Write us an email: <i>cryptobox[at]systemausfall.org</i>
</p>
<h2 id="Acknowledgements">Acknowledgements</h2>
<ul><li>We are looking for more translations. Take a look at the &#34;README&#34;-file in our <a href="/trac/cryptobox/browser/trunk/cbox-tree.d/usr/share/cryptobox/lang/">language section</a>. There you can find further instructions if you'd like to contribute.
</li><li>Open up a <a class="ext-link" title="https://systemausfall.org/trac/cryptobox/newticket" href="https://systemausfall.org/trac/cryptobox/newticket">ticket</a> for your feature requests and bugs.
</li></ul><h2 id="Development">Development</h2>
<ul><li>Take a look at the developer's documentation at <a href="?action=doc&page=CryptoBoxDev&weblang=en">CryptoBoxDev</a> for more information.
</li><li>The <a class="ext-link" title="https://systemausfall.org/trac/cryptobox/roadmap" href="https://systemausfall.org/trac/cryptobox/roadmap">development roadmap</a> shows our goals for the next release and the estimated release date.
</li><li>Join the development mailing list: <i><a class="ext-link" title="mailto:cryptobox-dev-subscribe@lists.systemausfall.org" href="mailto:cryptobox-dev-subscribe@lists.systemausfall.org">cryptobox-dev-subscribe@lists.systemausfall.org</a></i>.
</li><li>Browse the mailing list archive: <a class="ext-link" title="https://systemausfall.org/mail-archive" href="https://systemausfall.org/mail-archive">https://systemausfall.org/mail-archive</a>
</li></ul><h2 id="Acknowledgements">Acknowledgements</h2>
<p>
<ul><li>Clavdia Horvat, Tadej Brce &amp; Dušan Rebolj - slovenian translation
</li><li><a class="ext-link" title="http://codecoop.org" href="http://codecoop.org">http://codecoop.org</a> - webspace
@ -79,10 +85,69 @@ Anything else? Write us an email: <i>cryptobox[at]systemausfall.org</i>
</p>
<h2 id="Legalstuff">Legal stuff</h2>
<ol><li>All scripts are <a class="ext-link" title="http://www.fsf.org/licensing/licenses/gpl.html" href="http://www.fsf.org/licensing/licenses/gpl.html">GPL licensed</a>
</li><li>The documentation is licensed under a <a class="ext-link" title="http://creativecommons.org/licenses/by-sa-nc/2.0/" href="http://creativecommons.org/licenses/by-sa-nc/2.0/">Creative Commons License</a><i></i>
</li><li>We do not take any warranty for the functionality or usability of the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
</li><li>The documentation is licensed under a <a class="ext-link" title="http://creativecommons.org/licenses/by-nc-sa/2.0/" href="http://creativecommons.org/licenses/by-nc-sa/2.0/">Creative Commons License</a><i></i>
</li><li>We do not take any warranty for the functionality or usability of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
</li></ol><hr />
<h2 id="Comments">Comments</h2>
<h4 id="CommentbyanonymousonTueNov291354272005">Comment by anonymous on Tue Nov 29 13:54:27 2005</h4>
<p>
Let me just make sure I understand correctly.
The protected data is encrypted on the Cryptobox drive,
but is available in clear on the network, between the cryptobox and the user. Right?
</p>
<blockquote>
<p>
see the whole discussion at ticket <a href="/trac/cryptobox/ticket/83" title="NEW : implement DAV interface">#83*</a>
</p>
</blockquote>
<h4 id="CommentbyanonymousonSunDec40651502005">Comment by anonymous on Sun Dec 4 06:51:50 2005</h4>
<p>
<i>Do you have suggestions on how to secure the file transfer in a platform independent way?</i>
</p>
<p>
Perhaps the simplest thing to do would be make (one version of) <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> be a https (secure web server).
(Instead of, or in addition to, being a samba file server).
</p>
<p>
Web browsers use encryption when they upload a file to a &#34;https:// &#34; web server, right?
(using a &lt;FORM&gt; with &lt;INPUT type=&#34;file&#34; name=&#34;name_of_files&#34;&gt;, see
<a class="ext-link" title="http://www.w3.org/TR/html4/interact/forms.html#h-17.4" href="http://www.w3.org/TR/html4/interact/forms.html#h-17.4">http://www.w3.org/TR/html4/interact/forms.html#h-17.4</a>
).
Then one (static) web page on that server asks users to upload files using such a form.
</p>
<p>
All https servers use encryption when they download files, right?
So another (dynamic) web page on that server lists all of that user's files. Each one is hotlinked, so the user simply clicks on it to download / view it.
</p>
<p>
Perhaps a bit kludgy, but I think even unexperienced users could figure it out.
</p>
<blockquote>
<p>
see the whole discussion at ticket <a href="/trac/cryptobox/ticket/83" title="NEW : implement DAV interface">#83*</a>, too
</p>
</blockquote>
<h4 id="CommentbyanonymousonSatDec101215552005">Comment by anonymous on Sat Dec 10 12:15:55 2005</h4>
<p>
What happens when there are multiple hard drives in the machine? Will it erase all? Does it combine them to one share with something like raid or lvm, or will they be mountable as different shares? I'd try myself, but I currently only have one free hdd to test with.
btw, wonderful tool, keep up the good work, and tell us if you need more testers :-)
</p>
<blockquote>
<p>
If there are multiple harddisks available, then it will use only the first. <br />
We are going to implement an interface to manually partition harddisks and choose more than one of them for (seperated) encrypted containers. This feature should be available in the next release (v0.3).<br />
If you would like to help us (e.g. by testing), then you could subscribe to the mailing list.
</p>
</blockquote>
<h4 id="CommentbyanonymousonSatMay61041212006">Comment by anonymous on Sat May 6 10:41:21 2006</h4>
<p>
Could the hdd be external usb or firewire?
</p>
<blockquote>
<p>
yes - version 2.1 should support usb drives (firewire will work with 3.0)
</p>
</blockquote>
<p>
</div>

115
doc/html/en/CryptoBoxDev.html
View file

@ -8,99 +8,86 @@
<div class='wiki-toc'>
<h4>Table of Contents</h4>
<ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevPreparation#Preparationsfordevelopers&weblang=en">Preparations for developers</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevPreparation#Softwarerequirements&weblang=en">Software requirements</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevPreparation#Packages&weblang=en">Packages</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevPreparation#Kernel&weblang=en">Kernel</a></li>
</ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevPreparation#Getthesource&weblang=en">Get the source</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevPreparation#Firstbuild&weblang=en">First build</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevPreparation#Finished&weblang=en">Finished</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevPreparation#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxDevPreparation&weblang=en#Preparationsfordevelopers">Preparations for developers</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxDevPreparation&weblang=en#Softwarerequirements">Software requirements</a></li>
<li><a href="?action=doc&page=CryptoBoxDevPreparation&weblang=en#Getthesource">Get the source</a></li>
<li><a href="?action=doc&page=CryptoBoxDevPreparation&weblang=en#Firstbuild">First build</a></li>
<li><a href="?action=doc&page=CryptoBoxDevPreparation&weblang=en#Finished">Finished</a></li>
<li><a href="?action=doc&page=CryptoBoxDevPreparation&weblang=en#Comments">Comments</a></li>
</ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Developmentworkflow&weblang=en">Development workflow</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Preparations&weblang=en">Preparations</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#CreateaCryptoBoxLiveCD&weblang=en">Create a CryptoBox-LiveCD</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Buildthebasesystem&weblang=en">Build the base system</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Configurethebaseimage&weblang=en">Configure the base image</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Removedevelopmentfeatures&weblang=en">Remove development features</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Createanisoimage&weblang=en">Create an iso image</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#BurntheCD&weblang=en">Burn the CD</a></li>
</ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#TesttheCryptoBoxLiveCD&weblang=en">Test the CryptoBox-LiveCD</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Chrootquickampdirtytests&weblang=en">Chroot: quick &amp; dirty tests</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Qemunearlycompleteemulation&weblang=en">Qemu: nearly complete emulation</a></li>
</ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Debuggingandmerging&weblang=en">Debugging and merging</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Developmentonarunningsystem&weblang=en">Development on a running system</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Uploadinganewrelease&weblang=en">Uploading a new release</a></li>
</ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#Developmentworkflow">Development workflow</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#Preparations">Preparations</a></li>
<li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#CreateaCryptoBoxLiveCD">Create a CryptoBox-LiveCD</a></li>
<li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#TesttheCryptoBoxLiveCD">Test the CryptoBox-LiveCD</a></li>
<li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#Debuggingandmerging">Debugging and merging</a></li>
<li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#SettingupanewRelease">Setting up a new Release</a></li>
<li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#Comments">Comments</a></li>
</ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild#CustombuildsoftheCryptoBox&weblang=en">Custom builds of the CryptoBox</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild#Overview&weblang=en">Overview</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild#Settings&weblang=en">Settings</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild#dfsbuildsettings&weblang=en">dfsbuild settings</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild#CryptoBoxdevelopmentconfiguration&weblang=en">CryptoBox development configuration</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild#SSHconnection&weblang=en">SSH connection</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild#qemunetworkconfiguration&weblang=en">qemu network configuration</a></li>
</ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxDevCustomBuild&weblang=en#CustombuildsoftheCryptoBox">Custom builds of the CryptoBox</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxDevCustomBuild&weblang=en#Overview">Overview</a></li>
<li><a href="?action=doc&page=CryptoBoxDevCustomBuild&weblang=en#Settings">Settings</a></li>
<li><a href="?action=doc&page=CryptoBoxDevCustomBuild&weblang=en#Comments">Comments</a></li>
</ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomConfigure#CustomconfigurationoftheCryptoBox&weblang=en">Custom configuration of the CryptoBox</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomConfigure#Overview&weblang=en">Overview</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomConfigure#Locations&weblang=en">Locations</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomConfigure#Examples&weblang=en">Examples</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomConfigure#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxDevCustomConfigure&weblang=en#CustomconfigurationoftheCryptoBox">Custom configuration of the CryptoBox</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxDevCustomConfigure&weblang=en#Overview">Overview</a></li>
<li><a href="?action=doc&page=CryptoBoxDevCustomConfigure&weblang=en#Locations">Locations</a></li>
<li><a href="?action=doc&page=CryptoBoxDevCustomConfigure&weblang=en#Examples">Examples</a></li>
<li><a href="?action=doc&page=CryptoBoxDevCustomConfigure&weblang=en#Comments">Comments</a></li>
</ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevValidation#ValidationoftheCryptoBox&weblang=en">Validation of the CryptoBox</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevValidation#Overview&weblang=en">Overview</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevValidation#Validate&weblang=en">Validate</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevValidation#Howtocreateatest&weblang=en">How to create a test</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevValidation#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxDevValidation&weblang=en#ValidationoftheCryptoBox">Validation of the CryptoBox</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxDevValidation&weblang=en#Overview">Overview</a></li>
<li><a href="?action=doc&page=CryptoBoxDevValidation&weblang=en#Validate">Validate</a></li>
<li><a href="?action=doc&page=CryptoBoxDevValidation&weblang=en#Howtocreateatest">How to create a test</a></li>
<li><a href="?action=doc&page=CryptoBoxDevValidation&weblang=en#Comments">Comments</a></li>
</ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevBackground#DetailsoftheCryptoBox&weblang=en">Details of the CryptoBox</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevBackground#dfsbuild&weblang=en">dfsbuild</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevBackground#thekernel&weblang=en">the kernel</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevBackground#qemu&weblang=en">qemu</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevBackground#alternativeLiveCDs&weblang=en">alternative LiveCDs</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevBackground#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxDevBackground&weblang=en#DetailsoftheCryptoBox">Details of the CryptoBox</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxDevBackground&weblang=en#dfsbuild">dfsbuild</a></li>
<li><a href="?action=doc&page=CryptoBoxDevBackground&weblang=en#thekernel">the kernel</a></li>
<li><a href="?action=doc&page=CryptoBoxDevBackground&weblang=en#qemu">qemu</a></li>
<li><a href="?action=doc&page=CryptoBoxDevBackground&weblang=en#alternativeLiveCDs">alternative LiveCDs</a></li>
<li><a href="?action=doc&page=CryptoBoxDevBackground&weblang=en#Comments">Comments</a></li>
</ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevKnownProblems#Knownproblems&weblang=en">Known problems</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevKnownProblems#qemu&weblang=en">qemu</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevKnownProblems#interleavedfilesnotyetsupported&weblang=en">interleaved files not (yet) supported</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevKnownProblems#smbdsegfault&weblang=en">smbd: segfault</a></li>
</ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevKnownProblems#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxDevKnownProblems&weblang=en#Knownproblems">Known problems</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxDevKnownProblems&weblang=en#qemu">qemu</a></li>
<li><a href="?action=doc&page=CryptoBoxDevKnownProblems&weblang=en#dfsbuild">dfsbuild</a></li>
<li><a href="?action=doc&page=CryptoBoxDevKnownProblems&weblang=en#Comments">Comments</a></li>
</ol>
</ol>
</div>
</p>
<p>
<strong>Navigation:</strong> ( <a href="/cryptobox?action=doc&page=CryptoBox">CryptoBox/de</a>, <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox/en</a>)
<strong>Navigation:</strong> ( <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox/de</a>, <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox/en</a>)
</p>
<hr />
<h1 id="Developmentdocumentation">Development documentation</h1>
<p>
The following pages are written for developers only. <br />
Users of the <a href="/cryptobox?action=doc&page=CryptoBox">CryptoBox</a> should read <a href="/cryptobox?action=doc&page=CryptoBoxUser&weblang=en">CryptoBoxUser</a> instead.
Users of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> should read <a href="?action=doc&page=CryptoBoxUser&weblang=en">CryptoBoxUser</a> instead.
</p>
<ul><li><a href="/cryptobox?action=doc&page=CryptoBoxDevPreparation&weblang=en">CryptoBoxDevPreparation</a>
</li><li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow&weblang=en">CryptoBoxDevWorkFlow</a>
</li><li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild&weblang=en">CryptoBoxDevCustomBuild</a>
</li><li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomConfigure&weblang=en">CryptoBoxDevCustomConfigure</a>
</li><li><a href="/cryptobox?action=doc&page=CryptoBoxDevValidation&weblang=en">CryptoBoxDevValidation</a>
</li><li><a href="/cryptobox?action=doc&page=CryptoBoxDevBackground&weblang=en">CryptoBoxDevBackground</a>
</li><li><a href="/cryptobox?action=doc&page=CryptoBoxDevKnownProblems&weblang=en">CryptoBoxDevKnownProblems</a>
<ul><li><a href="?action=doc&page=CryptoBoxDevPreparation&weblang=en">CryptoBoxDevPreparation</a>
</li><li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en">CryptoBoxDevWorkFlow</a>
</li><li><a href="?action=doc&page=CryptoBoxDevCustomBuild&weblang=en">CryptoBoxDevCustomBuild</a>
</li><li><a href="?action=doc&page=CryptoBoxDevCustomConfigure&weblang=en">CryptoBoxDevCustomConfigure</a>
</li><li><a href="?action=doc&page=CryptoBoxDevValidation&weblang=en">CryptoBoxDevValidation</a>
</li><li><a href="?action=doc&page=CryptoBoxDevBackground&weblang=en">CryptoBoxDevBackground</a>
</li><li><a href="?action=doc&page=CryptoBoxDevKnownProblems&weblang=en">CryptoBoxDevKnownProblems</a>
</li></ul><h2 id="Source">Source</h2>
<p>
You may browse the <a href="/trac/cryptobox/browser/">source code</a>.
</p>
<h2 id="Contact">Contact</h2>
<p>
We are waiting for your emails to <i>cryptobox[at]systemausfall.org</i>.
Join the mailing list: <a class="ext-link" title="mailto:cryptobox-dev-subscribe@lists.systemausfall.org" href="mailto:cryptobox-dev-subscribe@lists.systemausfall.org">cryptobox-dev-subscribe@lists.systemausfall.org</a>.
</p>
<h2 id="Bugreports">Bug reports</h2>
<p>
Please use our issue tracker, if you discover problems: <a class="ext-link" title="https://systemausfall.org/trac/cryptobox/newticket" href="https://systemausfall.org/trac/cryptobox/newticket">https://systemausfall.org/trac/cryptobox/newticket</a>
If you think you found a bug or you get an error message, please help us to fix the problem and file a ticket (a bug report). Follow these steps:
</p>
</div>
<ol><li>Have a look at <a href="/trac/cryptobox/report/1">Open bugs</a> that need to be fixed
</li><li>Create a <a class="ext-link" title="https://systemausfall.org/trac/cryptobox/newticket" href="https://systemausfall.org/trac/cryptobox/newticket">New Ticket</a>
</li></ol></div>
</div>

29
doc/html/en/CryptoBoxDevBackground.html
View file

@ -8,24 +8,24 @@
<div class='wiki-toc'>
<h4>Table of Contents</h4>
<ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevBackground#dfsbuild&weblang=en">dfsbuild</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevBackground#thekernel&weblang=en">the kernel</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevBackground#qemu&weblang=en">qemu</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevBackground#alternativeLiveCDs&weblang=en">alternative LiveCDs</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevBackground#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxDevBackground&weblang=en#dfsbuild">dfsbuild</a></li>
<li><a href="?action=doc&page=CryptoBoxDevBackground&weblang=en#thekernel">the kernel</a></li>
<li><a href="?action=doc&page=CryptoBoxDevBackground&weblang=en#qemu">qemu</a></li>
<li><a href="?action=doc&page=CryptoBoxDevBackground&weblang=en#alternativeLiveCDs">alternative LiveCDs</a></li>
<li><a href="?action=doc&page=CryptoBoxDevBackground&weblang=en#Comments">Comments</a></li>
</ol>
</div>
</p>
<p>
<strong>Navigation:</strong> ( <a href="/cryptobox?action=doc&page=CryptoBoxDev&weblang=en">CryptoBoxDev</a>)
<strong>Navigation:</strong> ( <a href="?action=doc&page=CryptoBoxDev&weblang=en">CryptoBoxDev</a>)
</p>
<hr />
<h1 id="DetailsoftheCryptoBox">Details of the CryptoBox</h1>
<h2 id="dfsbuild">dfsbuild</h2>
<p>
The base system of the <a href="/cryptobox?action=doc&page=CryptoBox">CryptoBox</a> Live-CD is created by <a class="ext-link" title="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=dfsbuild" href="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=dfsbuild&weblang=en">dfsbuild</a>.
The base system of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> Live-CD is created by <a class="ext-link" title="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=dfsbuild" href="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=dfsbuild">dfsbuild</a>.
</p>
<p>
It is recommended to use some kind of caching tool for the retrieval of the debian packages (e.g.: <a class="ext-link" title="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=apt-cacher" href="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=apt-cacher">apt-cacher</a>, <a class="ext-link" title="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=apt-proxy" href="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=apt-proxy">apt-proxy</a> or <a class="ext-link" title="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=approx" href="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=approx">approx</a>). This saves a lot of bandwidth and time.
@ -37,22 +37,25 @@ The documentation for <a class="ext-link" title="http://packages.debian.org/cgi-
</li><li><a class="ext-link" title="http://www.debian-administration.org/articles/149" href="http://www.debian-administration.org/articles/149">Debian Administration: Getting in deep with dfsbuild</a>
</li></ul><h2 id="thekernel">the kernel</h2>
<p>
The linux kernel for the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> is compiled statically. If you want to change it, you could follow this steps:
The linux kernel for the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> is compiled statically. If you want to change it, you could follow this steps:
</p>
<ol><li>get the sources: <tt>apt-get install kernel-tree-2.6.11</tt> (or the version of your choice)
</li><li>copy the exisiting config file <i>kernel/config-2.6.11</i> as <i>.config</i> into your kernel source directory
</li><li>build the debian kernel package <tt>make-kpkg --revision=1.dfs --rootcmd=fakeroot kernel_image</tt>
</li><li>change the kernel in the <i>unpackdebs</i> setting in <a href="/trac/cryptobox/browser/trunk/etc-defaults.d/dfs-cbox.conf">dfs-cbox.conf</a> (see <a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild&weblang=en">CryptoBoxDevCustomBuild</a> for details)
</li></ol><h2 id="qemu">qemu</h2>
</li><li>change the kernel in the <i>unpackdebs</i> setting in <a href="/trac/cryptobox/browser/trunk/etc-defaults.d/dfs-cbox.conf">dfs-cbox.conf</a> (see <a href="?action=doc&page=CryptoBoxDevCustomBuild&weblang=en">CryptoBoxDevCustomBuild</a> for details)
</li></ol><p>
See <a title="" href="/trac/cryptobox/browser/trunk/hints/kernel-build.txt">source:trunk/hints/kernel-build.txt</a> for more details.
</p>
<h2 id="qemu">qemu</h2>
<p>
<a class="ext-link" title="http://fabrice.bellard.free.fr/qemu/" href="http://fabrice.bellard.free.fr/qemu/">Qemu</a> is a portable system emulator. It is a convenient tool to ease the development workflow, as you do not need to burn LiveCDs for testing.
</p>
<h2 id="alternativeLiveCDs">alternative LiveCDs</h2>
<p>
We tried some other LiveCDs before we decided to use <a class="ext-link" title="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=dfsbuild" href="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=dfsbuild">dfsbuild</a>. The following pages describe their advantages and disadvantages as the base system for the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>:
We tried some other LiveCDs before we decided to use <a class="ext-link" title="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=dfsbuild" href="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=dfsbuild">dfsbuild</a>. The following pages describe their advantages and disadvantages as the base system for the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>:
</p>
<ul><li><a href="/cryptobox?action=doc&page=CryptoBoxKnoppixVerworfen&weblang=en">CryptoBoxKnoppixVerworfen</a> - Knoppix
</li><li><a href="/cryptobox?action=doc&page=CryptoBoxMorphixVerworfen&weblang=en">CryptoBoxMorphixVerworfen</a> - Morphix / IBuild
<ul><li><a href="?action=doc&page=CryptoBoxKnoppixVerworfen&weblang=en">CryptoBoxKnoppixVerworfen</a> - Knoppix
</li><li><a href="?action=doc&page=CryptoBoxMorphixVerworfen&weblang=en">CryptoBoxMorphixVerworfen</a> - Morphix / IBuild
</li></ul><hr />
<h2 id="Comments">Comments</h2>
<p>

30
doc/html/en/CryptoBoxDevCustomBuild.html
View file

@ -8,29 +8,29 @@
<div class='wiki-toc'>
<h4>Table of Contents</h4>
<ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild#Overview&weblang=en">Overview</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild#Settings&weblang=en">Settings</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild#dfsbuildsettings&weblang=en">dfsbuild settings</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild#CryptoBoxdevelopmentconfiguration&weblang=en">CryptoBox development configuration</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild#SSHconnection&weblang=en">SSH connection</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild#qemunetworkconfiguration&weblang=en">qemu network configuration</a></li>
</ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxDevCustomBuild&weblang=en#Overview">Overview</a></li>
<li><a href="?action=doc&page=CryptoBoxDevCustomBuild&weblang=en#Settings">Settings</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxDevCustomBuild&weblang=en#dfsbuildsettings">dfsbuild settings</a></li>
<li><a href="?action=doc&page=CryptoBoxDevCustomBuild&weblang=en#CryptoBoxdevelopmentconfiguration">CryptoBox development configuration</a></li>
<li><a href="?action=doc&page=CryptoBoxDevCustomBuild&weblang=en#SSHconnection">SSH connection</a></li>
<li><a href="?action=doc&page=CryptoBoxDevCustomBuild&weblang=en#qemunetworkconfiguration">qemu network configuration</a></li>
</ol><li><a href="?action=doc&page=CryptoBoxDevCustomBuild&weblang=en#Comments">Comments</a></li>
</ol>
</div>
</p>
<p>
<strong>Navigation:</strong> ( <a href="/cryptobox?action=doc&page=CryptoBoxDev">CryptoBoxDev</a>, <a href="/cryptobox?action=doc&page=CryptoBoxDevBackground">CryptoBoxDevBackground</a>, <a href="/trac/cryptobox/wiki/CryptoBoxDevPreparation">CryptoBoxDevPreparation</a>, <a href="/trac/cryptobox/wiki/CryptoBoxDevWorkFlow&weblang=en">CryptoBoxDevWorkFlow</a>)
<strong>Navigation:</strong> ( <a href="?action=doc&page=CryptoBoxDev&weblang=en">CryptoBoxDev</a>, <a href="?action=doc&page=CryptoBoxDevBackground&weblang=en">CryptoBoxDevBackground</a>, <a href="/trac/cryptobox/wiki/CryptoBoxDevPreparation">CryptoBoxDevPreparation</a>, <a href="/trac/cryptobox/wiki/CryptoBoxDevWorkFlow">CryptoBoxDevWorkFlow</a>)
</p>
<hr />
<h1 id="CustombuildsoftheCryptoBox">Custom builds of the CryptoBox</h1>
<h2 id="Overview">Overview</h2>
<p>
The following sections are useful, if you want to change the default settings of your personal <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> development environment.
The following sections are useful, if you want to change the default settings of your personal <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> development environment.
</p>
<p>
You should have completed the steps described in <a href="/cryptobox?action=doc&page=CryptoBoxDevPreparation&weblang=en">CryptoBoxDevPreparation</a>.
You should have completed the steps described in <a href="?action=doc&page=CryptoBoxDevPreparation&weblang=en">CryptoBoxDevPreparation</a>.
</p>
<h2 id="Settings">Settings</h2>
<h3 id="dfsbuildsettings">dfsbuild settings</h3>
@ -47,7 +47,7 @@ This allows you to use your own (personal) settings, without interfering with fi
</p>
<h3 id="CryptoBoxdevelopmentconfiguration">CryptoBox development configuration</h3>
<p>
Some settings regarding the building, configuring and validating of the <a href="/cryptobox?action=doc&page=CryptoBox">CryptoBox</a> can be found in <a href="/trac/cryptobox/browser/trunk/etc-defaults.d/cbox-dev.conf&weblang=en">etc-defaults.d/cbox-dev.conf</a>.
Some settings regarding the building, configuring and validating of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> can be found in <a href="/trac/cryptobox/browser/trunk/etc-defaults.d/cbox-dev.conf">etc-defaults.d/cbox-dev.conf</a>.
</p>
<p>
If you want to change any of them, you should do the following:
@ -56,13 +56,13 @@ If you want to change any of them, you should do the following:
</li><li>change <i>etc-local.d/cbox-dev.conf</i> according to your needs
</li></ol><h3 id="SSHconnection">SSH connection</h3>
<p>
The file <a href="/trac/cryptobox/browser/trunk/etc-defaults.d/ssh_config">ssh_config</a> is used to establish a connection to a running <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> system.
The file <a href="/trac/cryptobox/browser/trunk/etc-defaults.d/ssh_config">ssh_config</a> is used to establish a connection to a running <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> system.
</p>
<p>
It can be necessary to change these settings, if:
</p>
<ul><li>you do not want to use the default IP for the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>
</li><li>or the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> is not within your local network.
<ul><li>you do not want to use the default IP for the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>
</li><li>or the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> is not within your local network.
</li></ul><p>
If you want to change some settings, you should do the following:
</p>
@ -70,7 +70,7 @@ If you want to change some settings, you should do the following:
</li><li>change <i>etc-local.d/ssh_config</i> according to your needs
</li></ol><h3 id="qemunetworkconfiguration">qemu network configuration</h3>
<p>
The file <a href="/trac/cryptobox/browser/trunk/etc-defauolts.d/qemu-ifup">etc-defauolts.d/qemu-ifup</a> is used for the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> emulation with <i>qemu</i>. See <i>man qemu</i> for details.
The file <a href="/trac/cryptobox/browser/trunk/etc-defauolts.d/qemu-ifup">etc-defauolts.d/qemu-ifup</a> is used for the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> emulation with <i>qemu</i>. See <i>man qemu</i> for details.
</p>
<p>
If you want to change some settings, you should do the following:

16
doc/html/en/CryptoBoxDevCustomConfigure.html
View file

@ -8,26 +8,26 @@
<div class='wiki-toc'>
<h4>Table of Contents</h4>
<ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomConfigure#Overview&weblang=en">Overview</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomConfigure#Locations&weblang=en">Locations</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomConfigure#Examples&weblang=en">Examples</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevCustomConfigure#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxDevCustomConfigure&weblang=en#Overview">Overview</a></li>
<li><a href="?action=doc&page=CryptoBoxDevCustomConfigure&weblang=en#Locations">Locations</a></li>
<li><a href="?action=doc&page=CryptoBoxDevCustomConfigure&weblang=en#Examples">Examples</a></li>
<li><a href="?action=doc&page=CryptoBoxDevCustomConfigure&weblang=en#Comments">Comments</a></li>
</ol>
</div>
</p>
<p>
<strong>Navigation:</strong> ( <a href="/cryptobox?action=doc&page=CryptoBoxDev&weblang=en">CryptoBoxDev</a>)
<strong>Navigation:</strong> ( <a href="?action=doc&page=CryptoBoxDev&weblang=en">CryptoBoxDev</a>)
</p>
<hr />
<h1 id="CustomconfigurationoftheCryptoBox">Custom configuration of the CryptoBox</h1>
<h2 id="Overview">Overview</h2>
<p>
You may change nearly every aspect of the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> by using the custom configuration hook directory.
You may change nearly every aspect of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> by using the custom configuration hook directory.
</p>
<p>
Any script inside of this directory will be executed after the default configuration procedure (see <a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow&weblang=en">CryptoBoxDevWorkFlow</a>).
Any script inside of this directory will be executed after the default configuration procedure (see <a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en">CryptoBoxDevWorkFlow</a>).
</p>
<p>
The order of execution is defined by the names of the scripts (alphabetically).
@ -48,7 +48,7 @@ The examples in <a href="/trac/cryptobox/browser/trunk/configure-examples.d">con
</td></tr><tr><td>set_default_language</td><td>set the default language
</td></tr><tr><td>set_default_timeout</td><td>set the default idle time for automatic unmounting
</td></tr><tr><td>set_hostname</td><td>change the default hostname
</td></tr><tr><td>set_root_pw</td><td>change the password of root (only useful for a development <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>)
</td></tr><tr><td>set_root_pw</td><td>change the password of root (only useful for a development <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>)
</td></tr><tr><td>import_authorized_keys</td><td>upload a <i>ssh</i> key for passwordless access to a development CryptoBox
</td></tr><tr><td>set_scan_devices</td><td>where to look for usable harddisks
</td></tr></table>

17
doc/html/en/CryptoBoxDevKnownProblems.html
View file

@ -8,16 +8,18 @@
<div class='wiki-toc'>
<h4>Table of Contents</h4>
<ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevKnownProblems#qemu&weblang=en">qemu</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevKnownProblems#interleavedfilesnotyetsupported&weblang=en">interleaved files not (yet) supported</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevKnownProblems#smbdsegfault&weblang=en">smbd: segfault</a></li>
</ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevKnownProblems#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxDevKnownProblems&weblang=en#qemu">qemu</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxDevKnownProblems&weblang=en#interleavedfilesnotyetsupported">interleaved files not (yet) supported</a></li>
<li><a href="?action=doc&page=CryptoBoxDevKnownProblems&weblang=en#smbdsegfault">smbd: segfault</a></li>
</ol><li><a href="?action=doc&page=CryptoBoxDevKnownProblems&weblang=en#dfsbuild">dfsbuild</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxDevKnownProblems&weblang=en#cantcdto_builddirtargetvarlibaptlists">can't cd to _builddir/target/var/lib/apt/lists</a></li>
</ol><li><a href="?action=doc&page=CryptoBoxDevKnownProblems&weblang=en#Comments">Comments</a></li>
</ol>
</div>
</p>
<p>
<strong>Navigation:</strong> ( <a href="/cryptobox?action=doc&page=CryptoBoxDev&weblang=en">CryptoBoxDev</a>)
<strong>Navigation:</strong> ( <a href="?action=doc&page=CryptoBoxDev&weblang=en">CryptoBoxDev</a>)
</p>
<hr />
@ -31,6 +33,11 @@ You should update <i>qemu</i> to version 0.7 or higher.
<p>
This happens under certain circumstances. We do not know a solution for this problem.
</p>
<h2 id="dfsbuild">dfsbuild</h2>
<h3 id="cantcdto_builddirtargetvarlibaptlists">can't cd to _builddir/target/var/lib/apt/lists</h3>
<p>
Try to downgrade <a class="ext-link" title="http://packages.debian.org/stable/admin/cdebootstrap" href="http://packages.debian.org/stable/admin/cdebootstrap">cdebootstrap</a> to v0.3.4 (for debian: <i>apt-get install cdebootstrap/stable</i>). This problem occours at least up to v0.3.8 of <a class="ext-link" title="http://packages.debian.org/stable/admin/cdebootstrap" href="http://packages.debian.org/stable/admin/cdebootstrap">cdebootstrap</a>.
</p>
<hr />
<h2 id="Comments">Comments</h2>
<p>

26
doc/html/en/CryptoBoxDevPreparation.html
View file

@ -8,19 +8,19 @@
<div class='wiki-toc'>
<h4>Table of Contents</h4>
<ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevPreparation#Softwarerequirements&weblang=en">Software requirements</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevPreparation#Packages&weblang=en">Packages</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevPreparation#Kernel&weblang=en">Kernel</a></li>
</ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevPreparation#Getthesource&weblang=en">Get the source</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevPreparation#Firstbuild&weblang=en">First build</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevPreparation#Finished&weblang=en">Finished</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevPreparation#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxDevPreparation&weblang=en#Softwarerequirements">Software requirements</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxDevPreparation&weblang=en#Packages">Packages</a></li>
<li><a href="?action=doc&page=CryptoBoxDevPreparation&weblang=en#Kernel">Kernel</a></li>
</ol><li><a href="?action=doc&page=CryptoBoxDevPreparation&weblang=en#Getthesource">Get the source</a></li>
<li><a href="?action=doc&page=CryptoBoxDevPreparation&weblang=en#Firstbuild">First build</a></li>
<li><a href="?action=doc&page=CryptoBoxDevPreparation&weblang=en#Finished">Finished</a></li>
<li><a href="?action=doc&page=CryptoBoxDevPreparation&weblang=en#Comments">Comments</a></li>
</ol>
</div>
</p>
<p>
<strong>Navigation:</strong> ( <a href="/cryptobox?action=doc&page=CryptoBoxDev">CryptoBoxDev</a>, <a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild">CryptoBoxDevCustomBuild</a>, <a href="/trac/cryptobox/wiki/CryptoBoxDevWorkFlow&weblang=en">CryptoBoxDevWorkFlow</a>)
<strong>Navigation:</strong> ( <a href="?action=doc&page=CryptoBoxDev&weblang=en">CryptoBoxDev</a>, <a href="?action=doc&page=CryptoBoxDevCustomBuild&weblang=en">CryptoBoxDevCustomBuild</a>, <a href="/trac/cryptobox/wiki/CryptoBoxDevWorkFlow">CryptoBoxDevWorkFlow</a>)
</p>
<hr />
@ -44,7 +44,7 @@ recommended:
</li><li><a class="ext-link" title="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=curl" href="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=curl">curl</a>
</li></ul><h3 id="Kernel">Kernel</h3>
<p>
If you want to use <a class="ext-link" title="http://fabrice.bellard.free.fr/qemu/" href="http://fabrice.bellard.free.fr/qemu/">qemu</a> to test your <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> in a virtual environment, then you will need the <i>tun/tap</i> kernel feature.
If you want to use <a class="ext-link" title="http://fabrice.bellard.free.fr/qemu/" href="http://fabrice.bellard.free.fr/qemu/">qemu</a> to test your <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> in a virtual environment, then you will need the <i>tun/tap</i> kernel feature.
</p>
<pre class="wiki">CONFIG_TUN=m
</pre><h2 id="Getthesource">Get the source</h2>
@ -57,17 +57,17 @@ Download the latest release from our <a class="ext-link" title="http://subversio
run <tt>scripts/cbox-build.sh release</tt> as <i>root</i> - hopefully, there should be no errors :)
</p>
<p>
Hint: This step will fail, if you did not install <i>apt-cacher</i>. See <a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild&weblang=en">CryptoBoxDevCustomBuild</a> for details on how to change the build-configuration settings (in this case: <i>mirror</i> in <i>dfs-cbox.conf</i>).
Hint: This step will fail, if you did not install <i>apt-cacher</i>. See <a href="?action=doc&page=CryptoBoxDevCustomBuild&weblang=en">CryptoBoxDevCustomBuild</a> for details on how to change the build-configuration settings (in this case: <i>mirror</i> in <i>dfs-cbox.conf</i>).
</p>
<h2 id="Finished">Finished</h2>
<p>
Now you can start to pariticipate in the development of the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> or simply customize your own CryptoBox-LiveCD.
Now you can start to pariticipate in the development of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> or simply customize your own CryptoBox-LiveCD.
</p>
<p>
See <a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow">CryptoBoxDevWorkFlow</a> for details of how to use the developer's tools of the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
See <a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en">CryptoBoxDevWorkFlow</a> for details of how to use the developer's tools of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
</p>
<p>
<a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild">CryptoBoxDevCustomBuild</a> shows some examples for local customizations of the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
<a href="?action=doc&page=CryptoBoxDevCustomBuild&weblang=en">CryptoBoxDevCustomBuild</a> shows some examples for local customizations of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
</p>
<hr />
<h2 id="Comments">Comments</h2>

16
doc/html/en/CryptoBoxDevValidation.html
View file

@ -8,23 +8,23 @@
<div class='wiki-toc'>
<h4>Table of Contents</h4>
<ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevValidation#Overview&weblang=en">Overview</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevValidation#Validate&weblang=en">Validate</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevValidation#Howtocreateatest&weblang=en">How to create a test</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevValidation#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxDevValidation&weblang=en#Overview">Overview</a></li>
<li><a href="?action=doc&page=CryptoBoxDevValidation&weblang=en#Validate">Validate</a></li>
<li><a href="?action=doc&page=CryptoBoxDevValidation&weblang=en#Howtocreateatest">How to create a test</a></li>
<li><a href="?action=doc&page=CryptoBoxDevValidation&weblang=en#Comments">Comments</a></li>
</ol>
</div>
</p>
<p>
<strong>Navigation:</strong> ( <a href="/cryptobox?action=doc&page=CryptoBoxDev&weblang=en">CryptoBoxDev</a>)
<strong>Navigation:</strong> ( <a href="?action=doc&page=CryptoBoxDev&weblang=en">CryptoBoxDev</a>)
</p>
<hr />
<h1 id="ValidationoftheCryptoBox">Validation of the CryptoBox</h1>
<h2 id="Overview">Overview</h2>
<p>
The validation feature helps you to check the programming logic of the <a href="/cryptobox?action=doc&page=CryptoBox">CryptoBox</a>. A lot of test cases are defined to verify as many functions of the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> as possible.
The validation feature helps you to check the programming logic of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>. A lot of test cases are defined to verify as many functions of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> as possible.
</p>
<p>
The requests are processed with <a class="ext-link" title="http://curl.haxx.se/" href="http://curl.haxx.se/">curl</a>.
@ -33,7 +33,7 @@ The requests are processed with <a class="ext-link" title="http://curl.haxx.se/"
The received web page is saved to allow a later design review or css debugging.
</p>
<p>
The current state of the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> is represented by ten single values (e.g.: <i>box is configured</i>, <i>IP of the box</i>, <i>current language setting</i>, ...), which are invisibly a part of each html page (as comments). The returned status of every request is compared to the predicted value of the test case.
The current state of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> is represented by ten single values (e.g.: <i>box is configured</i>, <i>IP of the box</i>, <i>current language setting</i>, ...), which are invisibly a part of each html page (as comments). The returned status of every request is compared to the predicted value of the test case.
</p>
<p>
Similar test cases are pooled into test groups (e.g.: <i>initialization</i>, <i>configuration</i> and <i>mounting</i>).
@ -57,7 +57,7 @@ Every test consists of the following files:
</p>
<table class="wiki">
<tr><td>input.curl</td><td>the configuration file for the <i>curl</i> request
</td></tr><tr><td>output</td><td>the predicted state of the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> after the call
</td></tr><tr><td>output</td><td>the predicted state of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> after the call
</td></tr><tr><td>description</td><td>a short description of the test (will be used for the summary)
</td></tr><tr><td>delay</td><td>[optional] time to wait after this test
</td></tr></table>

61
doc/html/en/CryptoBoxDevWorkFlow.html
View file

@ -8,40 +8,41 @@
<div class='wiki-toc'>
<h4>Table of Contents</h4>
<ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Preparations&weblang=en">Preparations</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#CreateaCryptoBoxLiveCD&weblang=en">Create a CryptoBox-LiveCD</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Buildthebasesystem&weblang=en">Build the base system</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Configurethebaseimage&weblang=en">Configure the base image</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Removedevelopmentfeatures&weblang=en">Remove development features</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Createanisoimage&weblang=en">Create an iso image</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#BurntheCD&weblang=en">Burn the CD</a></li>
</ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#TesttheCryptoBoxLiveCD&weblang=en">Test the CryptoBox-LiveCD</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Chrootquickampdirtytests&weblang=en">Chroot: quick &amp; dirty tests</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Qemunearlycompleteemulation&weblang=en">Qemu: nearly complete emulation</a></li>
</ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Debuggingandmerging&weblang=en">Debugging and merging</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Developmentonarunningsystem&weblang=en">Development on a running system</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Uploadinganewrelease&weblang=en">Uploading a new release</a></li>
</ol><li><a href="/cryptobox?action=doc&page=CryptoBoxDevWorkFlow#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#Preparations">Preparations</a></li>
<li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#CreateaCryptoBoxLiveCD">Create a CryptoBox-LiveCD</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#Buildthebasesystem">Build the base system</a></li>
<li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#Configurethebaseimage">Configure the base image</a></li>
<li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#Removedevelopmentfeatures">Remove development features</a></li>
<li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#Createanisoimage">Create an iso image</a></li>
<li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#BurntheCD">Burn the CD</a></li>
</ol><li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#TesttheCryptoBoxLiveCD">Test the CryptoBox-LiveCD</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#Chrootquickampdirtytests">Chroot: quick &amp; dirty tests</a></li>
<li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#Qemunearlycompleteemulation">Qemu: nearly complete emulation</a></li>
</ol><li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#Debuggingandmerging">Debugging and merging</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#Developmentonarunningsystem">Development on a running system</a></li>
<li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#Copyingatestversion">Copying a testversion</a></li>
</ol><li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#SettingupanewRelease">Setting up a new Release</a></li>
<li><a href="?action=doc&page=CryptoBoxDevWorkFlow&weblang=en#Comments">Comments</a></li>
</ol>
</div>
</p>
<p>
<strong>Navigation:</strong> ( <a href="/cryptobox?action=doc&page=CryptoBoxDev">CryptoBoxDev</a>, <a href="/cryptobox?action=doc&page=CryptoBoxDevCustomConfigure">CryptoBoxDevCustomConfigure</a>, <a href="/trac/cryptobox/wiki/CryptoBoxDevPreparation&weblang=en">CryptoBoxDevPreparation</a>)
<strong>Navigation:</strong> ( <a href="?action=doc&page=CryptoBoxDev&weblang=en">CryptoBoxDev</a>, <a href="?action=doc&page=CryptoBoxDevCustomConfigure&weblang=en">CryptoBoxDevCustomConfigure</a>, <a href="/trac/cryptobox/wiki/CryptoBoxDevPreparation">CryptoBoxDevPreparation</a>)
</p>
<hr />
<h1 id="Developmentworkflow">Development workflow</h1>
<h2 id="Preparations">Preparations</h2>
<p>
You should have completed the steps described in <a href="/cryptobox?action=doc&page=CryptoBoxDevPreparation&weblang=en">CryptoBoxDevPreparation</a>.
You should have completed the steps described in <a href="?action=doc&page=CryptoBoxDevPreparation&weblang=en">CryptoBoxDevPreparation</a>.
</p>
<h2 id="CreateaCryptoBoxLiveCD">Create a CryptoBox-LiveCD</h2>
<p>
The following steps can be executed in the order of their appearance.
</p>
<p>
Usually there is no need to repeat the whole process, after you changed some parts of the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>. Especially the first step (building of the base system with <i>dfsbuild</i>) may usually be skipped.
Usually there is no need to repeat the whole process, after you changed some parts of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>. Especially the first step (building of the base system with <i>dfsbuild</i>) may usually be skipped.
</p>
<p>
Every step of the building process must be executed as <i>root</i>.
@ -54,7 +55,7 @@ Run <i>scripts/cbox-build.sh dfsbuild</i> to create the base system for the Live
The result can be found in <i>_builddir/cd1/image</i>.
</p>
<p>
If you do not want to use the <i><a class="ext-link" title="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=apt-cacher" href="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=apt-cacher">apt-cacher</a> to save bandwidth and time, then you should modify the </i>mirror<i>-setting in <a href="/trac/cryptobox/browser/trunk/etc-default.d/dfs-cbox.conf">dfs-cbox.conf</a> (see <a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild&weblang=en">CryptoBoxDevCustomBuild</a> for details).</i>
If you do not want to use the <i><a class="ext-link" title="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=apt-cacher" href="http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&amp;subword=0&amp;version=all&amp;release=all&amp;keywords=apt-cacher">apt-cacher</a> to save bandwidth and time, then you should modify the </i>mirror<i>-setting in <a href="/trac/cryptobox/browser/trunk/etc-default.d/dfs-cbox.conf">dfs-cbox.conf</a> (see <a href="?action=doc&page=CryptoBoxDevCustomBuild&weblang=en">CryptoBoxDevCustomBuild</a> for details).</i>
</p>
<h3 id="Configurethebaseimage">Configure the base image</h3>
<p>
@ -86,18 +87,18 @@ Do it manually:
(change the <i>dev</i> setting according to your setup).
</p>
<p>
Let the script do it for you: <i>scripts/cbox-build.sh burn</i> (maybe you have to change the <i>CDWRITER</i> setting in <a href="/trac/cryptobox/browser/trunk/etc-defaults.d/cbox-dev.conf">cbox-dev.conf</a> - see <a href="/cryptobox?action=doc&page=CryptoBoxDevCustomBuild&weblang=en">CryptoBoxDevCustomBuild</a>).
Let the script do it for you: <i>scripts/cbox-build.sh burn</i> (maybe you have to change the <i>CDWRITER</i> setting in <a href="/trac/cryptobox/browser/trunk/etc-defaults.d/cbox-dev.conf">cbox-dev.conf</a> - see <a href="?action=doc&page=CryptoBoxDevCustomBuild&weblang=en">CryptoBoxDevCustomBuild</a>).
</p>
<p>
Of course, it is not wise to use CD-R media. CD-RW consume less resources.
</p>
<h2 id="TesttheCryptoBoxLiveCD">Test the CryptoBox-LiveCD</h2>
<p>
This section is only useful for developers, who want to improve or change the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> system.
This section is only useful for developers, who want to improve or change the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> system.
</p>
<h3 id="Chrootquickampdirtytests">Chroot: quick &amp; dirty tests</h3>
<p>
If you modified the <i>perl</i>- or <i>shell</i>-scripts of the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>, then you can check for syntax errors by running them in a <i>chroot</i> environment. Be careful: you have access to all ressources of your computer, while you are working within a <i>chroot</i> environment - so you can easily repartition your real disk ...
If you modified the <i>perl</i>- or <i>shell</i>-scripts of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>, then you can check for syntax errors by running them in a <i>chroot</i> environment. Be careful: you have access to all ressources of your computer, while you are working within a <i>chroot</i> environment - so you can easily repartition your real disk ...
</p>
<p>
To start a <i>chroot</i> environment, you can execute <i>scripts/cbox-dev.sh chroot</i>.
@ -107,7 +108,7 @@ For more intensive tests, you may use <i>qemu</i> (see below) or burn real LiveC
</p>
<h3 id="Qemunearlycompleteemulation">Qemu: nearly complete emulation</h3>
<p>
The processor emulator <a class="ext-link" title="http://fabrice.bellard.free.fr/qemu" href="http://fabrice.bellard.free.fr/qemu">qemu</a> allows you test the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> in a virtual environment, that is completely separated from your real computer's resources. It is the tool of choice, if you do nat have a real computer around for testing.
The processor emulator <a class="ext-link" title="http://fabrice.bellard.free.fr/qemu" href="http://fabrice.bellard.free.fr/qemu">qemu</a> allows you test the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> in a virtual environment, that is completely separated from your real computer's resources. It is the tool of choice, if you do nat have a real computer around for testing.
</p>
<p>
Beware - there are some problems, when using <i>qemu</i>:
@ -120,10 +121,10 @@ To start a <i>qemu</i> emulation of the <i>iso</i> image, you may type:
<pre class="wiki">scripts/cbox-dev.sh qemu
</pre><h2 id="Debuggingandmerging">Debugging and merging</h2>
<p>
This section is only useful for developers, who want to develop on a running <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> system (emulated or real).
This section is only useful for developers, who want to develop on a running <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> system (emulated or real).
</p>
<p>
You may access the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> directly or you can use <i>ssh</i> to open a remote session:
You may access the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> directly or you can use <i>ssh</i> to open a remote session:
</p>
<pre class="wiki">./cbox-dev.sh ssh
</pre><h3 id="Developmentonarunningsystem">Development on a running system</h3>
@ -131,17 +132,21 @@ You may access the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">Cry
When you run an emulation or test a real LiveCD, you may encounter problems and bugs. To test your fixes for these problems, it is convenient, to change the running test system. Afterwards you can merge these changes to your local development copy.
</p>
<p>
Type <i>scripts/cbox-dev.sh diff</i> to see the changes, you made on the running <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> system.
Type <i>scripts/cbox-dev.sh diff</i> to see the changes, you made on the running <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> system.
</p>
<p>
Type <i>scripts/cbox-dev.sh merge</i> to merge these changes to your local working copy.
</p>
<h3 id="Uploadinganewrelease">Uploading a new release</h3>
<h3 id="Copyingatestversion">Copying a testversion</h3>
<p>
Alternatively you may also upload a new version of your local working copy to the running <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> system.
Alternatively you may also upload a new version of your local working copy to the running <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> system.
</p>
<p>
Type <i>scripts/cbox-dev.sh upload</i> - beware: all recent changes you made to the running <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> system, are lost.
Type <i>scripts/cbox-dev.sh upload</i> - beware: all recent changes you made to the running <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> system, are lost.
</p>
<h2 id="SettingupanewRelease">Setting up a new Release</h2>
<p>
Once you finished your development, you surely want to make a new release. Please read the instructions in the <a href="/trac/cryptobox/browser/trunk/hints/release-policy.txt">releas-policy.txt</a> it will save you a lot of time! Then you basically just have to run <i>scripts/cbox-build.sh release</i> and get yourself a good coffee. After the command has finished you'll see the releasefiles in <i>_buildir</i>.
</p>
<hr />
<h2 id="Comments">Comments</h2>

50
doc/html/en/CryptoBoxUser.html
View file

@ -8,47 +8,47 @@
<div class='wiki-toc'>
<h4>Table of Contents</h4>
<ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserGettingStarted#Gettingstarted&weblang=en">Getting started</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxUserGettingStarted#FirstSteps&weblang=en">First Steps</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserGettingStarted#HintsCaveats&weblang=en">Hints / Caveats</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserGettingStarted#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxUserGettingStarted&weblang=en#Gettingstarted">Getting started</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxUserGettingStarted&weblang=en#FirstSteps">First Steps</a></li>
<li><a href="?action=doc&page=CryptoBoxUserGettingStarted&weblang=en#HintsCaveats">Hints / Caveats</a></li>
<li><a href="?action=doc&page=CryptoBoxUserGettingStarted&weblang=en#Comments">Comments</a></li>
</ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration#ConfigurationofyourCryptoBox&weblang=en">Configuration of your CryptoBox</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration#Overview&weblang=en">Overview</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration#Foreword&weblang=en">Foreword</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration#Initialization&weblang=en">Initialization</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration#Configuration&weblang=en">Configuration</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration#HintsCaveats&weblang=en">Hints / Caveats</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#ConfigurationofyourCryptoBox">Configuration of your CryptoBox</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Overview">Overview</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Foreword">Foreword</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Initialization">Initialization</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Configuration">Configuration</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#HintsCaveats">Hints / Caveats</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Comments">Comments</a></li>
</ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserDailyUse#DailyuseoftheCryptoBox&weblang=en">Daily use of the CryptoBox</a></li>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxUserDailyUse#Activateyourencryptedfilesystem&weblang=en">Activate your encrypted filesystem</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserDailyUse#Useyourencrypteddata&weblang=en">Use your encrypted data</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserDailyUse#Deactivateyourencryptedfilesystem&weblang=en">Deactivate your encrypted filesystem</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserDailyUse#ShutdownyourCryptoBox&weblang=en">Shut down your CryptoBox</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserDailyUse#Incaseofemergency&weblang=en">In case of emergency</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserDailyUse#QuestionsandAnswers&weblang=en">Questions and Answers</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserDailyUse#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#DailyuseoftheCryptoBox">Daily use of the CryptoBox</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Activateyourencryptedfilesystem">Activate your encrypted filesystem</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Useyourencrypteddata">Use your encrypted data</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Deactivateyourencryptedfilesystem">Deactivate your encrypted filesystem</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#ShutdownyourCryptoBox">Shut down your CryptoBox</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Incaseofemergency">In case of emergency</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#QuestionsandAnswers">Questions and Answers</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Comments">Comments</a></li>
</ol>
</ol>
</div>
</p>
<p>
<strong>Navigation:</strong> ( <a href="/cryptobox?action=doc&page=CryptoBox">CryptoBox/en</a>, <a href="/cryptobox?action=doc&page=CryptoBoxUser&weblang=en">CryptoBoxUser</a>)
<strong>Navigation:</strong> ( <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox/en</a>, <a href="?action=doc&page=CryptoBoxUser&weblang=en">CryptoBoxUser</a>)
</p>
<hr />
<h1 id="UserDocumentation">User Documentation</h1>
<p>
The following pages describe the easy use of the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
The following pages describe the easy use of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
</p>
<p>
The online version of this manual is a wiki, which means you can edit the pages. So if you have a question or you perceive a description as unclear, please post it on the bottom of the relevant page. The developers will answer your questions and update the manual as fast as possible. This way you can contribute in making the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> a better experience for everyone!
The online version of this manual is a wiki, which means you can edit the pages. So if you have a question or you perceive a description as unclear, please post it on the bottom of the relevant page. The developers will answer your questions and update the manual as fast as possible. This way you can contribute in making the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> a better experience for everyone!
</p>
<ol><li><a href="/cryptobox?action=doc&page=CryptoBoxUserGettingStarted&weblang=en">CryptoBoxUserGettingStarted</a> -- first steps to get the Cryptobox up and running
</li><li><a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration&weblang=en">CryptoBoxUserConfiguration</a> -- configure the details of your new encrypted fileserver
</li><li><a href="/cryptobox?action=doc&page=CryptoBoxUserDailyUse">CryptoBoxUserDailyUse</a> -- daily use of your <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>
<ol><li><a href="?action=doc&page=CryptoBoxUserGettingStarted&weblang=en">CryptoBoxUserGettingStarted</a> -- first steps to get the Cryptobox up and running
</li><li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en">CryptoBoxUserConfiguration</a> -- configure the details of your new encrypted fileserver
</li><li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en">CryptoBoxUserDailyUse</a> -- daily use of your <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>
</li></ol><p>
The online version of this manual can be found at <a class="ext-link" title="https://systemausfall.org/trac/cryptobox/wiki/CryptoBoxUser/en" href="https://systemausfall.org/trac/cryptobox/wiki/CryptoBoxUser/en">https://systemausfall.org/trac/cryptobox/wiki/CryptoBoxUser/en</a>.
</p>

70
doc/html/en/CryptoBoxUserConfiguration.html
View file

@ -8,55 +8,74 @@
<div class='wiki-toc'>
<h4>Table of Contents</h4>
<ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration#Overview&weblang=en">Overview</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration#Foreword&weblang=en">Foreword</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration#Initialization&weblang=en">Initialization</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration#Configuration&weblang=en">Configuration</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration#HintsCaveats&weblang=en">Hints / Caveats</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxUserGettingStarted&weblang=en#Gettingstarted">Getting started</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxUserGettingStarted&weblang=en#FirstSteps">First Steps</a></li>
<li><a href="?action=doc&page=CryptoBoxUserGettingStarted&weblang=en#HintsCaveats">Hints / Caveats</a></li>
<li><a href="?action=doc&page=CryptoBoxUserGettingStarted&weblang=en#Comments">Comments</a></li>
</ol>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#ConfigurationofyourCryptoBox">Configuration of your CryptoBox</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Overview">Overview</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Foreword">Foreword</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Initialization">Initialization</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Configuration">Configuration</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#HintsCaveats">Hints / Caveats</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Comments">Comments</a></li>
</ol>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#DailyuseoftheCryptoBox">Daily use of the CryptoBox</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Activateyourencryptedfilesystem">Activate your encrypted filesystem</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Useyourencrypteddata">Use your encrypted data</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Deactivateyourencryptedfilesystem">Deactivate your encrypted filesystem</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#ShutdownyourCryptoBox">Shut down your CryptoBox</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Incaseofemergency">In case of emergency</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#QuestionsandAnswers">Questions and Answers</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Comments">Comments</a></li>
</ol>
</ol>
</div>
</p>
<p>
<strong>Navigation:</strong> ( <a href="/cryptobox?action=doc&page=CryptoBoxUser">CryptoBoxUser/en</a>, <a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration&weblang=en">CryptoBoxUserConfiguration</a>)
<strong>Navigation:</strong> ( <a href="?action=doc&page=CryptoBoxUser&weblang=en">CryptoBoxUser/en</a>, <a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en">CryptoBoxUserConfiguration</a>)
</p>
<hr />
<h1 id="ConfigurationofyourCryptoBox">Configuration of your CryptoBox</h1>
<h2 id="Overview">Overview</h2>
<p>
All parts of administration of the <a href="/cryptobox?action=doc&page=CryptoBox">CryptoBox</a> are done through a comfortable web interface. If this is the first time you use the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>, just follow the steps below.
All parts of administration of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> are done through a comfortable web interface. If this is the first time you use the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>, just follow the steps below.
</p>
<p>
You can safely ignore the <a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration#Foreword&weblang=en">Foreword</a> if you are in a hurry.
You can safely ignore the <a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Foreword">Foreword</a> if you are in a hurry.
</p>
<p>
<a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration#Initialization">Initialization</a> describes the process of integrating a new harddisk. You usually have to perform this steps if you start with a new <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> or after replacing the harddisk.
<a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Initialization">Initialization</a> describes the process of integrating a new harddisk. You usually have to perform this steps if you start with a new <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> or after replacing the harddisk.
</p>
<p>
In the <a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration#Configuration">Configuration</a> section, you can configure the <a href="/cryptobox?action=doc&page=CryptoBox">CryptoBox</a> according to your personal needs, e.g. change your desired language for the web interface or change the IP address of the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
In the <a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Configuration">Configuration</a> section, you can configure the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> according to your personal needs, e.g. change your desired language for the web interface or change the IP address of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
</p>
<p>
Do not forget to read the <a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration#HintsCaveats&weblang=en">Hints / Caveats</a> section too.
Do not forget to read the <a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#HintsCaveats">Hints / Caveats</a> section too.
</p>
<h2 id="Foreword">Foreword</h2>
<p>
Okay, you finished the <a href="/cryptobox?action=doc&page=CryptoBoxUserGettingStarted">CryptoBoxUserGettingStarted</a> and are now sitting in front of a computer that is connected via network with your <a href="/cryptobox?action=doc&page=CryptoBox">CryptoBox</a>. You point a browser to &#34;<a class="ext-link" title="https://192.168.0.23&#34;" href="https://192.168.0.23&#34;">https://192.168.0.23&#34;</a> and the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> interface appears.
Okay, you finished the <a href="?action=doc&page=CryptoBoxUserGettingStarted&weblang=en">CryptoBoxUserGettingStarted</a> and are now sitting in front of a computer that is connected via network with your <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>. You point a browser to &#34;<a class="ext-link" title="https://192.168.0.23&#34;" href="https://192.168.0.23&#34;">https://192.168.0.23&#34;</a> and the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> interface appears.
</p>
<p>
Before you can save data on your <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>, its harddisk has to be formatted with a cryptographic filesystem. Sounds complicated but don't be scared - it's really a &#34;one click&#34; thing. :)
Before you can save data on your <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>, its harddisk has to be formatted with a cryptographic filesystem. Sounds complicated but don't be scared - it's really a &#34;one click&#34; thing. :)
</p>
<h2 id="Initialization">Initialization</h2>
<p>
Click on <i>Initialize CryptoBox</i> in the title bar.
Click on <i>Initialize CryptoBox</i> in the title bar.
</p>
<p>
<a href='/trac/cryptobox/file/trunk/www-data/screenshots/en_init.png' style='padding:0; border:none'><img src='/trac/cryptobox/file/trunk/www-data/screenshots/en_init.png?format=raw' alt="en_init.png" title="en_init.png" style="" /></a>
</p>
<p>
Now you are promted to enter two passwords twice (because we want to train your typing skills ;).
</p>
<ul><li>The first password is the <i>administration password</i>.
<ul><li>It is used to protect the configuration of the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
</li><li>This is necessary to make sure, that no one without your permission can destroy your data by re-initializing the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
<ul><li>It is used to protect the configuration of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
</li><li>This is necessary to make sure, that no one without your permission can destroy your data by re-initializing the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
</li><li>Chances are good, that you will only need it once.
</li><li>You may leave it empty, but this is not recommended.
</li></ul></li><li>The <i>crypto password</i> is the more important password, protecting the data on your harddisk. Choose it wisely!
@ -74,26 +93,29 @@ The initialization process takes place in the background and will be completed a
<p>
While the initialization is usually done only once, the configuration can be changed at any time you want. You can reach it by clicking at <i>Configuration</i> in the menu bar of the website. Now you see a form with four fields:
</p>
<ul><li>If you defined a administration passwort during <i>Initialization</i>, you have to enter it first. Otherwise this field does not appear.
<p>
<a href='/trac/cryptobox/file/trunk/www-data/screenshots/en_config.png' style='padding:0; border:none'><img src='/trac/cryptobox/file/trunk/www-data/screenshots/en_config.png?format=raw' alt="en_config.png" title="en_config.png" style="" /></a>
</p>
<ul><li>If you defined an administration password during <i>Initialization</i>, you have to enter it first. Otherwise this field does not appear.
</li><li>If the default network address (IP) doesn't fit into your network infrastructure, you can change it in the second field.
</li><li>The timeout defines the amount of time (in minutes) after that the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> deactivates the access to the encrypted data. If you e.g. copy a file on the box, it starts counting at zero, so down-/uploads won't be interrupted.
</li><li>The timeout defines the amount of time (in minutes) after that the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> deactivates the access to the encrypted data. If you e.g. copy a file on the box, it starts counting at zero, so down-/uploads won't be interrupted.
</li><li>It's good choice to enter a small number (few minutes).
</li><li>A timeout of <i>0</i> turns off the automatic deactivation - this is not recommended.
</li><li>At <i>language preferences</i> you can select the default language for the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> interface.
</li><li>At <i>language preferences</i> you can select the default language for the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> interface.
</li></ul><p>
Complete your changes by clicking on <i>Save configuration</i>.
</p>
<p>
That's all - your <a href="/cryptobox?action=doc&page=CryptoBox">CryptoBox</a> is now ready for <a href="/cryptobox?action=doc&page=CryptoBoxUserDailyUse&weblang=en">daily use</a>!
That's all - your <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> is now ready for <a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en">daily use</a>!
</p>
<h2 id="HintsCaveats">Hints / Caveats</h2>
<ul><li>All data on the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> harddisk will be erased during <i>Initialization</i>.
<ul><li>All data on the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> harddisk will be erased during <i>Initialization</i>.
</li><li>All passwords have to be typed twice to reduce the chance of a typo.
</li><li>The optional adminstration password is necessary for configuration only.
</li><li>The crypto password protects your beloved data.
</li><li>If the cryptobox is not reachable by browsing to 192.168.0.23, you may have to adjust the network settings of your computer for initialization of the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
</li><li>If the cryptobox is not reachable by browsing to 192.168.0.23, you may have to adjust the network settings of your computer for initialization of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
</li></ul><p>
<i>back to <a href="/cryptobox?action=doc&page=CryptoBoxUser&weblang=en">CryptoBoxUser</a></i>
<i>back to <a href="?action=doc&page=CryptoBoxUser&weblang=en">CryptoBoxUser</a></i>
</p>
<hr />
<h2 id="Comments">Comments</h2>

52
doc/html/en/CryptoBoxUserDailyUse.html
View file

@ -8,19 +8,34 @@
<div class='wiki-toc'>
<h4>Table of Contents</h4>
<ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserDailyUse#Activateyourencryptedfilesystem&weblang=en">Activate your encrypted filesystem</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserDailyUse#Useyourencrypteddata&weblang=en">Use your encrypted data</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserDailyUse#Deactivateyourencryptedfilesystem&weblang=en">Deactivate your encrypted filesystem</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserDailyUse#ShutdownyourCryptoBox&weblang=en">Shut down your CryptoBox</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserDailyUse#Incaseofemergency&weblang=en">In case of emergency</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserDailyUse#QuestionsandAnswers&weblang=en">Questions and Answers</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserDailyUse#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxUserGettingStarted&weblang=en#Gettingstarted">Getting started</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxUserGettingStarted&weblang=en#FirstSteps">First Steps</a></li>
<li><a href="?action=doc&page=CryptoBoxUserGettingStarted&weblang=en#HintsCaveats">Hints / Caveats</a></li>
<li><a href="?action=doc&page=CryptoBoxUserGettingStarted&weblang=en#Comments">Comments</a></li>
</ol>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#ConfigurationofyourCryptoBox">Configuration of your CryptoBox</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Overview">Overview</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Foreword">Foreword</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Initialization">Initialization</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Configuration">Configuration</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#HintsCaveats">Hints / Caveats</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Comments">Comments</a></li>
</ol>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#DailyuseoftheCryptoBox">Daily use of the CryptoBox</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Activateyourencryptedfilesystem">Activate your encrypted filesystem</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Useyourencrypteddata">Use your encrypted data</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Deactivateyourencryptedfilesystem">Deactivate your encrypted filesystem</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#ShutdownyourCryptoBox">Shut down your CryptoBox</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Incaseofemergency">In case of emergency</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#QuestionsandAnswers">Questions and Answers</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Comments">Comments</a></li>
</ol>
</ol>
</div>
</p>
<p>
<strong>Navigation:</strong> ( <a href="/cryptobox?action=doc&page=CryptoBoxUser">CryptoBoxUser/en</a>, <a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration">CryptoBoxUserConfiguration/en</a>, <a href="/trac/cryptobox/wiki/CryptoBoxUserDailyUse&weblang=en">CryptoBoxUserDailyUse</a>)
<strong>Navigation:</strong> ( <a href="?action=doc&page=CryptoBoxUser&weblang=en">CryptoBoxUser/en</a>, <a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en">CryptoBoxUserConfiguration/en</a>, <a href="/trac/cryptobox/wiki/CryptoBoxUserDailyUse">CryptoBoxUserDailyUse</a>)
</p>
<hr />
@ -29,7 +44,7 @@
<p>
You can activate your encrypted filesystem by doing following these steps:
</p>
<ul><li>Point your web browser at the address of your <a href="/cryptobox?action=doc&page=CryptoBox">CryptoBox</a>. The default is <a class="ext-link" title="https://192.168.0.23" href="https://192.168.0.23&weblang=en">https://192.168.0.23</a>.
<ul><li>Point your web browser at the address of your <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>. The default is <a class="ext-link" title="https://192.168.0.23" href="https://192.168.0.23">https://192.168.0.23</a>.
</li><li>Click on <i>Activation of encrypted data</i>. A new page asking for your crypto password appears.
</li><li>Enter your crypto password and click on the button below labeled <i>activate encrypted filesystem</i>.
</li></ul><p>
@ -51,16 +66,19 @@ resp. unmount:
<pre class="wiki">smbumount /mnt
</pre><h3 id="Windows">Windows</h3>
<p>
Run the the Windows Explorer and choose <i>Map network drive</i> in the <i>Extras</i> menu:
Run the the Windows Explorer and choose <i>Map network drive</i> in the <i>Tools</i> menu:
</p>
<ul><li>select a drive of your choice
</li><li>enter <i>\\192.168.0.23\public</i> (default setting) as target
</li></ul><p>
<a href='/trac/cryptobox/file/trunk/www-data/screenshots/en_w98_network_drive.png' style='padding:0; border:none'><img src='/trac/cryptobox/file/trunk/www-data/screenshots/en_w98_network_drive.png?format=raw' alt="en_w98_network_drive.png" title="en_w98_network_drive.png" style="" /></a>
</p>
<p>
Now you can use your encrypted data like any other network resource.
</p>
<h2 id="Deactivateyourencryptedfilesystem">Deactivate your encrypted filesystem</h2>
<p>
You can deactivate the encrypted filesystem by clicking at <i>Deactivation of encrypted data</i> in the web interface of your <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
You can deactivate the encrypted filesystem by clicking at <i>Deactivation of encrypted data</i> in the web interface of your <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a>.
</p>
<p>
Your data is now protected again.
@ -70,24 +88,30 @@ Your data is now protected again.
Click at the <i>Shutdown</i> link in the menu of the web interface. There you can choose <i>poweroff</i> or <i>reboot</i>. The shutdown takes some seconds.
</p>
<p>
If the hardware of your <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> is quite recent, it will power-off automatically. Otherwise you have to do it manually.
If the hardware of your <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> is quite recent, it will power-off automatically. Otherwise you have to do it manually.
</p>
<h2 id="Incaseofemergency">In case of emergency</h2>
<p>
If you have to protect the drive really fast, just power-off the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> machine instantly by pulling the plug or pushing the power button. This is not very clean and can (in very rare circumstances) corrupt open files, but it is the fasted method to secure your data.
If you have to protect the drive really fast, just power-off the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> machine instantly by pulling the plug or pushing the power button. This is not very clean and can (in very rare circumstances) corrupt open files, but it is the fastest method to secure your data.
</p>
<p>
<i>back to <a href="/cryptobox?action=doc&page=CryptoBoxUser&weblang=en">CryptoBoxUser</a></i>
<i>back to <a href="?action=doc&page=CryptoBoxUser&weblang=en">CryptoBoxUser</a></i>
</p>
<hr />
<h2 id="QuestionsandAnswers">Questions and Answers</h2>
<h3 id="Windowsnetworkdrivecannotbemapped">Windows: network drive cannot be mapped</h3>
<p>
<a href='/trac/cryptobox/file/trunk/www-data/screenshots/en_w98_not_logged_in.png' style='padding:0; border:none'><img src='/trac/cryptobox/file/trunk/www-data/screenshots/en_w98_not_logged_in.png?format=raw' alt="en_w98_not_logged_in.png" title="en_w98_not_logged_in.png" style="" /></a>
</p>
<p>
This error message may appear, if you did not login during the booting of you windows machine (or you closed the login dialog by pressing ESC).
</p>
<p>
<strong>Solution:</strong> Choose <i>Logout</i> in the <i>Start</i> menu and login again.
</p>
<p>
<a href='/trac/cryptobox/file/trunk/www-data/screenshots/en_w98_login.png' style='padding:0; border:none'><img src='/trac/cryptobox/file/trunk/www-data/screenshots/en_w98_login.png?format=raw' alt="en_w98_login.png" title="en_w98_login.png" style="" /></a>
</p>
<h3 id="Linuxonlyrootcanunmount192168023public">Linux: only root can unmount //192.168.0.23/public</h3>
<p>
You can't unmount the partition with <i>umount</i>.

43
doc/html/en/CryptoBoxUserGettingStarted.html
View file

@ -8,53 +8,72 @@
<div class='wiki-toc'>
<h4>Table of Contents</h4>
<ol>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserGettingStarted#FirstSteps&weblang=en">First Steps</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserGettingStarted#HintsCaveats&weblang=en">Hints / Caveats</a></li>
<li><a href="/cryptobox?action=doc&page=CryptoBoxUserGettingStarted#Comments&weblang=en">Comments</a></li>
<li><a href="?action=doc&page=CryptoBoxUserGettingStarted&weblang=en#Gettingstarted">Getting started</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxUserGettingStarted&weblang=en#FirstSteps">First Steps</a></li>
<li><a href="?action=doc&page=CryptoBoxUserGettingStarted&weblang=en#HintsCaveats">Hints / Caveats</a></li>
<li><a href="?action=doc&page=CryptoBoxUserGettingStarted&weblang=en#Comments">Comments</a></li>
</ol>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#ConfigurationofyourCryptoBox">Configuration of your CryptoBox</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Overview">Overview</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Foreword">Foreword</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Initialization">Initialization</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Configuration">Configuration</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#HintsCaveats">Hints / Caveats</a></li>
<li><a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en#Comments">Comments</a></li>
</ol>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#DailyuseoftheCryptoBox">Daily use of the CryptoBox</a></li>
<ol><li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Activateyourencryptedfilesystem">Activate your encrypted filesystem</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Useyourencrypteddata">Use your encrypted data</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Deactivateyourencryptedfilesystem">Deactivate your encrypted filesystem</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#ShutdownyourCryptoBox">Shut down your CryptoBox</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Incaseofemergency">In case of emergency</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#QuestionsandAnswers">Questions and Answers</a></li>
<li><a href="?action=doc&page=CryptoBoxUserDailyUse&weblang=en#Comments">Comments</a></li>
</ol>
</ol>
</div>
</p>
<p>
<strong>Navigation:</strong> ( <a href="/cryptobox?action=doc&page=CryptoBoxUser">CryptoBoxUser/en</a>, <a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration">CryptoBoxUserConfiguration/en</a>, <a href="/trac/cryptobox/wiki/CryptoBoxUserGettingStarted&weblang=en">CryptoBoxUserGettingStarted</a>)
<strong>Navigation:</strong> ( <a href="?action=doc&page=CryptoBoxUser&weblang=en">CryptoBoxUser/en</a>, <a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en">CryptoBoxUserConfiguration/en</a>, <a href="/trac/cryptobox/wiki/CryptoBoxUserDailyUse/en">CryptoBoxUserDailyUse/en</a>, <a href="/trac/cryptobox/wiki/CryptoBoxUserGettingStarted">CryptoBoxUserGettingStarted</a>)
</p>
<hr />
<h1 id="Gettingstarted">Getting started</h1>
<h2 id="FirstSteps">First Steps</h2>
<p>
Getting the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> started doesn't take much:
Getting the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> started doesn't take much:
</p>
<ol><li>You need an old Computer (at least 100MHz, 48MB RAM) (rule of thumb: bought at least after 1996). This PC needs a network card, a CD-ROM drive and a huge harddisk.
<ul><li>Well the disk doesn't need to be huge, it should just suit your filestorage needs ;)
</li><li>You don't need a monitor or a keyboard to use your <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> (with one exception, see below).
</li><li>You don't need a monitor or a keyboard to use your <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> (with one exception, see below).
</li><li>Of course, you may use a faster computer, but they usually consume much more energy and do not provide signifcant advantages.
</li></ul></li><li>Then download the latest version of the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> as an iso-image and burn this image onto a CD.
</li></ul></li><li>Then download the latest version of the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> as an iso-image and burn this image onto a CD.
<ul><li><a class="ext-link" title="http://codecoop.org/projects/cryptobox/" href="http://codecoop.org/projects/cryptobox/">http://codecoop.org/projects/cryptobox/</a>
</li></ul></li><li>Configure your PC, so it can boot from the CD. Therefore you have to enter the BIOS and configure the CD-ROM as boot device.
</li><li>Insert the shiny new <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> CD you've just burned and start the computer.
</li><li>Insert the shiny new <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> CD you've just burned and start the computer.
</li></ol><p>
If it now boots from the CD, you accomplished all of the requirements.
</p>
<p>
Now you can just go to your current desktop computer and point your browser to <a class="ext-link" title="https://192.168.0.23" href="https://192.168.0.23">https://192.168.0.23</a> where the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> interface should be displayed. Easy - isn't it?
Now you can just go to your current desktop computer and point your browser to <a class="ext-link" title="https://192.168.0.23" href="https://192.168.0.23">https://192.168.0.23</a> where the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> interface should be displayed. Easy - isn't it?
</p>
<p>
For further steps go to <a href="/cryptobox?action=doc&page=CryptoBoxUserConfiguration&weblang=en">CryptoBoxUserConfiguration</a>.
For further steps go to <a href="?action=doc&page=CryptoBoxUserConfiguration&weblang=en">CryptoBoxUserConfiguration</a>.
</p>
<h2 id="HintsCaveats">Hints / Caveats</h2>
<p>
</p>
<ul><li>Maybe you need to change the network address (IP) of your PC to configure the <a href="/cryptobox?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> for the first time. Ask someone for help, if you don't know how and why ...
<ul><li>Maybe you need to change the network address (IP) of your PC to configure the <a href="?action=doc&page=CryptoBox&weblang=en">CryptoBox</a> for the first time. Ask someone for help, if you don't know how and why ...
</li><li>If you're going to buy a new harddisk keep in mind that very old hardware can't handle current disk sizes!
</li><li>Some old PCs are not able to boot from CD.
</li><li>If you don't know what a BIOS is, better ask someone, before you try to change something. ;)
</li><li>Don't forget to connect your PC to your local area network!
</li><li>To configure the BIOS, you need a keyboard and a monitor. But this has to be done only once.
</li></ul><p>
<i>back to <a href="/cryptobox?action=doc&page=CryptoBoxUser&weblang=en">CryptoBoxUser</a></i>
<i>back to <a href="?action=doc&page=CryptoBoxUser&weblang=en">CryptoBoxUser</a></i>
</p>
<hr />
<h2 id="Comments">Comments</h2>