mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-05-20 10:34:30 +00:00
doc: Update manual from latest wiki
This commit is contained in:
parent
60e52d2729
commit
17e96c624c
@ -6,15 +6,59 @@
|
|||||||
|
|
||||||
</articleinfo>
|
</articleinfo>
|
||||||
<section>
|
<section>
|
||||||
<title>FreedomBox Introduction</title>
|
<title>FreedomBox: take your online privacy back</title>
|
||||||
<para>FreedomBox is a personal server that protects your privacy. It is a free software stack, a subset of the Debian universal operating system, that can be installed in many flavors of inexpensive and power-efficient <ulink url="https://wiki.debian.org/FreedomBox/Hardware#">hardware</ulink>. The simplicity of setting up and operating a FreedomBox is similar to that of a smart phone. </para>
|
<para>FreedomBox is a ready made personal server designed with privacy in mind. Made of free software only, it is a subset of <ulink url="https://www.debian.org/">Debian universal operating system</ulink>. It can be installed as a full system on a small board dedicated for that use from home. It can also be installed on your computer as an additional program although it is not recommended.</para>
|
||||||
|
<para>In order to replace communication services proposed by private companies mining your entire life, you will be able to activate independent services and provide them on the Internet or at home only. These applications are communication services accessible from clients or browsers on your phones like chat and voice calls, calendar, address book, file or news feed sharing and synchronization, webmail... To provide a spy free chat service for instance, activate the service from your administration interface and create some new users. You will then be able to provide XMPP addresses to your friends. They will instant use XMPP clients (Conversations or Xabber on Android, Pidgin on Windows and Linux, Messages on Mac OS) for encrypted communications.</para>
|
||||||
|
<para>FreedomBox is also optionally a Wi-Fi router for more advanced users. </para>
|
||||||
|
<para>You need a bit of technical expertise or help from the community to set up FreedomBox at home on a specific inexpensive and power-efficient hardware or on your computer running Debian. But once installed , its use is similar to that of a smart phone. </para>
|
||||||
|
<para>Related documentation: </para>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
<ulink url="https://wiki.debian.org/FreedomBox/Features#">FreedomBox applications</ulink>
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
<ulink url="https://wiki.debian.org/FreedomBox/Hardware#">Machines that support FreedomBox</ulink>
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
<ulink url="https://wiki.debian.org/FreedomBox/Download#">Download and Install</ulink>
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual#">Manual</ulink>
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
<ulink url="https://wiki.debian.org/FreedomBox/Support#">Live Help from the community</ulink>
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
<section>
|
<section>
|
||||||
<title>Smart Router</title>
|
<title>Easy: Private Cloud</title>
|
||||||
|
<para>FreedomBox provides services: to your computers and mobile devices in your home and to computers and mobile devices of other people who are your friends. FreedomBox provides file sharing like Dropbox, shared calendering like Google or Yahoo and photo sharing. FreedomBox provides instant messaging and truly secure voice conference calling that works on low bandwidth providing high quality. FreedomBox has a blog and wiki to let you publish your content and collaborate with the rest of the world. Coming soon, a personal email server and federated social networking using GNU Social and Diaspora, providing privacy-respecting alternatives to Gmail and Facebook. </para>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<title>Advanced: Smart Home Router</title>
|
||||||
<para>FreedomBox runs in a physical computer and can route your traffic. It can sit between various devices at home such as mobiles, laptops and TVs and the Internet replacing a home wireless router. By routing traffic, FreedomBox can remove tracking advertisements and malicious web bugs before they ever reach your devices. FreedomBox can cloak your location and protect your anonymity by "onion routing" your traffic over Tor. FreedomBox provides a VPN server that you can use while you are away from home to keep your traffic secret on untrusted public wireless networks and to securely access various devices at home. It can also be carried along with your laptop and used to connect to public networks at work, school, or office to avail its services. It could be used in a village to provide communications throughout the village. In future, FreedomBox intends to provide support for alternative ways of connecting to the Internet such as Mesh networks. </para>
|
<para>FreedomBox runs in a physical computer and can route your traffic. It can sit between various devices at home such as mobiles, laptops and TVs and the Internet replacing a home wireless router. By routing traffic, FreedomBox can remove tracking advertisements and malicious web bugs before they ever reach your devices. FreedomBox can cloak your location and protect your anonymity by "onion routing" your traffic over Tor. FreedomBox provides a VPN server that you can use while you are away from home to keep your traffic secret on untrusted public wireless networks and to securely access various devices at home. It can also be carried along with your laptop and used to connect to public networks at work, school, or office to avail its services. It could be used in a village to provide communications throughout the village. In future, FreedomBox intends to provide support for alternative ways of connecting to the Internet such as Mesh networks. </para>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<title>Private Cloud</title>
|
<title>FreedomBox Interface Screenshot</title>
|
||||||
<para>FreedomBox provides services: to your computers and mobile devices in your home and to computers and mobile devices of other people who are your friends. FreedomBox provides file sharing like Dropbox, shared calendering like Google or Yahoo and photo sharing. FreedomBox provides instant messaging and truly secure voice conference calling that works on low bandwidth providing high quality. FreedomBox has a blog and wiki to let you publish your content and collaborate with the rest of the world. Coming soon, a personal email server and federated social networking using GNU Social and Diaspora, providing privacy-respecting alternatives to Gmail and Facebook. </para>
|
<para>
|
||||||
|
<inlinemediaobject>
|
||||||
|
<imageobject>
|
||||||
|
<imagedata fileref="images/freedombox2.png"/>
|
||||||
|
</imageobject>
|
||||||
|
<textobject>
|
||||||
|
<phrase>freedombox2.png</phrase>
|
||||||
|
</textobject>
|
||||||
|
</inlinemediaobject>
|
||||||
|
</para>
|
||||||
</section>
|
</section>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
@ -103,7 +147,7 @@
|
|||||||
<title>Release Notes</title>
|
<title>Release Notes</title>
|
||||||
<para>The following are the release notes for each FreedomBox version. </para>
|
<para>The following are the release notes for each FreedomBox version. </para>
|
||||||
<section>
|
<section>
|
||||||
<title>Version 0.9 (not released yet)</title>
|
<title>Version 0.9 (2016-04-24)</title>
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Fixed Wi-Fi AP setup. </para>
|
<para>Fixed Wi-Fi AP setup. </para>
|
||||||
@ -161,7 +205,7 @@
|
|||||||
<title>Version 0.7 (2015-12-13)</title>
|
<title>Version 0.7 (2015-12-13)</title>
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Translations! Full translations of the interface in Danish, Dutch, French, German and Norwegian Bokmål, and partial Telugu. </para>
|
<para>Translations! Full translations of the interface in Danish, Dutch, French, German and Norwegian , and partial Telugu. </para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Support for OLinuXino A20 MICRO and LIME2 </para>
|
<para>Support for OLinuXino A20 MICRO and LIME2 </para>
|
||||||
@ -361,7 +405,8 @@
|
|||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<title>Download and Install</title>
|
<title>Download and Install</title>
|
||||||
<para>Wellcome to the <ulink url="https://wiki.debian.org/FreedomBox#">FreedomBox</ulink> download page. You may either install FreedomBox on one of the supported inexpensive <ulink url="https://wiki.debian.org/FreedomBox/Hardware#">hardware</ulink>, on a Linux <ulink url="https://wiki.debian.org/FreedomBox/Hardware/Debian#">Debian</ulink> operating system, or deploy on a virtual machine. Installing on Debian is easy because <ulink url="https://wiki.debian.org/FreedomBox#">FreedomBox</ulink> is available as packages. On hardware, you may need a little bit of technical expertise to setup. What we are requiring is to buy a device and plug in an SD card. In case of trouble, please read and interact with the <ulink url="https://wiki.debian.org/FreedomBox/QuestionsAndAnswers#">Questions and Answers</ulink> page based on <ulink url="https://lists.alioth.debian.org/mailman/listinfo/freedombox-discuss">Freedombox-discuss</ulink> mailing list archives. </para>
|
<para>Wellcome to the FreedomBox download page. You may either install FreedomBox on one of the supported inexpensive <ulink url="https://wiki.debian.org/FreedomBox/Hardware#">hardware</ulink>, on a Linux <ulink url="https://wiki.debian.org/FreedomBox/Hardware/Debian#">Debian</ulink> operating system, or deploy on a virtual machine. </para>
|
||||||
|
<para>Installing on a machine running a Debian system is easy because FreedomBox is available as a package. We recommend to install FreedomBox on a supported single board computer though. The board will be dedicated for FreedomBox use from home. What we are requiring is to buy a device and plug in an SD card. In case of trouble when choosing the appropriate board or during install, please use <ulink url="https://wiki.debian.org/FreedomBox/Support#">Live Help</ulink> or read and interact with the <ulink url="https://wiki.debian.org/FreedomBox/QuestionsAndAnswers#">Questions and Answers</ulink> page based on <ulink url="https://lists.alioth.debian.org/mailman/listinfo/freedombox-discuss">Freedombox-discuss</ulink> mailing list archives. </para>
|
||||||
<section>
|
<section>
|
||||||
<title>Downloading on Debian</title>
|
<title>Downloading on Debian</title>
|
||||||
<para>If you are installing on Debian, you don't need to download these images. Instead read <ulink url="https://wiki.debian.org/FreedomBox/Hardware/Debian#">instructions</ulink> on setting up FreedomBox on Debian. </para>
|
<para>If you are installing on Debian, you don't need to download these images. Instead read <ulink url="https://wiki.debian.org/FreedomBox/Hardware/Debian#">instructions</ulink> on setting up FreedomBox on Debian. </para>
|
||||||
@ -603,6 +648,59 @@ Primary key fingerprint: BCBE BD57 A11F 70B2 3782 BC57 36C3 6144 0C9B C971</scr
|
|||||||
</listitem>
|
</listitem>
|
||||||
</orderedlist>
|
</orderedlist>
|
||||||
</section>
|
</section>
|
||||||
|
<section>
|
||||||
|
<title>Recap: How to create a DNS name with GnuDIP</title>
|
||||||
|
<para>
|
||||||
|
<remark>to delete or to replace the old text</remark>
|
||||||
|
</para>
|
||||||
|
<orderedlist numeration="arabic" inheritnum="ignore" continuation="restarts">
|
||||||
|
<listitem>
|
||||||
|
<para>Access to <ulink url="https://gnudip.datasystems24.net">GnuIP login page</ulink> (answer Yes to all pop ups) </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Click on "Self Register" </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Fill the registration form (Username and domain will form the public IP address [username.domain]) </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Take note of the username/hostname and password that will be used on the FreedomBox app. </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Save and return to the GnuDIP login page to verify your username, domain and password (enter the datas, click login). </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Login output should display your new domain name along with your current public IP address (this is a unique address provided by your router for all your local devices). </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Leave the GnuDIP interface and open the Dynamic DNS Client app page in your FreedomBox. </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Click on "Set Up" in the top menu. </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Activate Dynamic DNS </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Choose GnuDIP service. </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Add server address (gnudip.datasystems24.net) </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Add your fresh domain name (username.domain, ie [username].freedombox.rocks) </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Add your fresh username (the one used in your new IP address) and password </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Add your GnuDIP password </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Fill the option with <ulink url="http://myip.datasystems24.de"/> (try this url in your browser, you will figure out immediatly) </para>
|
||||||
|
</listitem>
|
||||||
|
</orderedlist>
|
||||||
|
</section>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<title>Roundcube</title>
|
<title>Roundcube</title>
|
||||||
@ -718,6 +816,24 @@ Primary key fingerprint: BCBE BD57 A11F 70B2 3782 BC57 36C3 6144 0C9B C971</scr
|
|||||||
<title>What is Ikiwiki?</title>
|
<title>What is Ikiwiki?</title>
|
||||||
<para>Ikiwiki converts wiki pages into HTML pages suitable for publishing on a website. It provides particularly blogging, podcasting, calendars and a large selection of plugins. </para>
|
<para>Ikiwiki converts wiki pages into HTML pages suitable for publishing on a website. It provides particularly blogging, podcasting, calendars and a large selection of plugins. </para>
|
||||||
</section>
|
</section>
|
||||||
|
<section>
|
||||||
|
<title>Quick Start</title>
|
||||||
|
<para>After the app installation on your box administration interface: </para>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>Go to "Create" section and create a wiki or a blog </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Go back to "Configure" section and click on /ikiwiki link </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Click on your new wiki or blog name under "Parent directory" </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Enjoy your new publication page. </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<title>Creating a wiki or blog</title>
|
<title>Creating a wiki or blog</title>
|
||||||
<para>You can create a wiki or blog to be hosted on your FreedomBox through the Wiki & Blog (Ikiwiki) page in Plinth. The first time you visit this page, it will ask to install packages required by Ikiwiki. </para>
|
<para>You can create a wiki or blog to be hosted on your FreedomBox through the Wiki & Blog (Ikiwiki) page in Plinth. The first time you visit this page, it will ask to install packages required by Ikiwiki. </para>
|
||||||
@ -812,6 +928,65 @@ Primary key fingerprint: BCBE BD57 A11F 70B2 3782 BC57 36C3 6144 0C9B C971</scr
|
|||||||
<para>GNU Social is still getting packaged for debian and will be available soon for everyone to use. check the progress by tracking the bug <ulink url="https://bugs.debian.org/782812#">#782812</ulink>. </para>
|
<para>GNU Social is still getting packaged for debian and will be available soon for everyone to use. check the progress by tracking the bug <ulink url="https://bugs.debian.org/782812#">#782812</ulink>. </para>
|
||||||
</section>
|
</section>
|
||||||
</section>
|
</section>
|
||||||
|
<section>
|
||||||
|
<title>Radicale</title>
|
||||||
|
<section>
|
||||||
|
<title>What is Radicale?</title>
|
||||||
|
<para>Radicale is a CalDAV and CardDAV server. It allows synchronization and sharing of calendar and contact data. To use the application, a <ulink url="http://radicale.org/user_documentation/#idcaldav-and-carddav-clients">supported client application</ulink> is needed. Radicale can be accessed by any user with a FreedomBox login. </para>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<title>Why running Radicale?</title>
|
||||||
|
<para>Using Radicale, you can get rid of centralized services like Google Calendar or Apple Calendar (iCloud) mining your events and social connections. </para>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<title>How to setup Radicale?</title>
|
||||||
|
<para>First, the Radicale server needs to be activated on your box. Then the mobile and computer clients need to be configured. </para>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>From your FreedomBox interface, go to "Calendar and Addressbook (Radicale)" page and install the application. After the installation is complete, make sure the application is marked "enabled" in the FreedomBox interface. Enabling the application launches the Radicale server CalDAV. </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Now open your clients to create new calendar and address books that will use your FreedomBox and Radicale server. Remember, your clients must be CalDAV and CardDAV compatible. The Radicale website provides <ulink url="http://radicale.org/user_documentation/#idstarting-the-client">tutorials to setup</ulink> a large selection of clients. </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Example of setup with Evolution client: </para>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>Contacts </para>
|
||||||
|
<orderedlist numeration="arabic" inheritnum="ignore" continuation="restarts">
|
||||||
|
<listitem>
|
||||||
|
<para>Create new address book </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>For "Type," select "WebDAV" </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>When "WebDAV" is selected, additional options will appear in the dialogue window. </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>URL: <code>https://IP</code> <emphasis>address or domain for your server</emphasis>/radicale/<emphasis>user</emphasis>/<emphasis>contact file name</emphasis>.vcf/. In addition, if you are using a contacts file exported from another service or application, it should be copied to: /var/lib/radicale/collections/<emphasis>user</emphasis>/<emphasis>contact file name</emphasis>.vcf. Items in <emphasis>italics</emphasis> need to be changed to match your settings. </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Select/check "Use a secure connection." </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Name the address book </para>
|
||||||
|
</listitem>
|
||||||
|
</orderedlist>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Calendar </para>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>Follow the same steps described above and replace WebDAV with CalDAV. The extension of the calendar file will be .ics. </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<title>System</title>
|
<title>System</title>
|
||||||
@ -2680,7 +2855,7 @@ firewall-cmd --permanent --zone=internal --add-interface=eth0</screen>
|
|||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<title>Availability</title>
|
<title>Availability</title>
|
||||||
<para>FreedomBox Danue Edition </para>
|
<para>FreedomBox Danube Edition </para>
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>A limited number of units are planned to be shipped along with the release of FreedomBox 1.0. If you wish to get one, <ulink url="http://projectdanube.org/freedombox/">express your interest</ulink>. </para>
|
<para>A limited number of units are planned to be shipped along with the release of FreedomBox 1.0. If you wish to get one, <ulink url="http://projectdanube.org/freedombox/">express your interest</ulink>. </para>
|
||||||
@ -3233,28 +3408,103 @@ firewall-cmd --permanent --zone=internal --add-interface=eth0</screen>
|
|||||||
<para>You don't want to disturb your Debian installation to try out FreedomBox. </para>
|
<para>You don't want to disturb your Debian installation to try out FreedomBox. </para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
|
<para>Prebuilt FreedomBox images for VirtualBox are routinely made available in <ulink url="https://wiki.debian.org/VirtualBox#">VirtualBox</ulink>'s own <ulink url="https://www.virtualbox.org/manual/ch05.html#vdidetails">VDI image file format</ulink>. They contain a Debian GNU/Linux operating system and an installation of FreedomBox with all dependencies ready to run on any OS supported by VirtualBox (Windows, Linux, Macintosh, and Solaris). </para>
|
||||||
|
<para>A more adventurous alternative to downloading one of these images is to <ulink url="https://wiki.debian.org/InstallingDebianOn#">install Debian</ulink> on VirtualBox and then <ulink url="https://wiki.debian.org/FreedomBox/Hardware/Debian#">install FreedomBox</ulink> on it. </para>
|
||||||
|
<para><ulink url="https://wiki.debian.org/VirtualBox#">VirtualBox</ulink> itself is available from <ulink url="https://www.virtualbox.org/"/> (or your distribution's package manager). </para>
|
||||||
<section>
|
<section>
|
||||||
<title>Download</title>
|
<title>Download</title>
|
||||||
<para>FreedomBox SD card images for this VirtualBox are available. Follow the instructions on the <ulink url="https://wiki.debian.org/FreedomBox/Download#">download</ulink> page to download and verify VirtualBox images. </para>
|
<para>Follow the instructions on the <ulink url="https://wiki.debian.org/FreedomBox/Download#">download</ulink> page to download and verify a VirtualBox image. As pr. 2016-03-26 the latest images are <ulink url="http://ftp.skolelinux.org/pub/freedombox/0.7/freedombox-unstable-free_2015-12-13_all-amd64.vdi.xz">v0.7-amd64</ulink> and <ulink url="http://ftp.skolelinux.org/pub/freedombox/0.7/freedombox-unstable-free_2015-12-13_all-i386.vdi.xz">v0.7-i386</ulink>. </para>
|
||||||
<para>An alternative to downloading these images is to <ulink url="https://wiki.debian.org/InstallingDebianOn#">install Debian</ulink> on VirtualBox and then <ulink url="https://wiki.debian.org/FreedomBox/Hardware/Debian#">install FreedomBox</ulink> on it. </para>
|
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<title>Creating a Virtual Machine</title>
|
<title>Creating a Virtual Machine</title>
|
||||||
<orderedlist numeration="arabic" inheritnum="ignore" continuation="restarts">
|
<orderedlist numeration="arabic" inheritnum="ignore" continuation="restarts">
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Decompress the downloaded VDI image. </para>
|
<para>Decompress the downloaded VDI image (tool for <ulink url="http://www.7-zip.org/">Windows</ulink>, <ulink url="http://unarchiver.c3.cx/unarchiver">Mac</ulink>). </para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Create a new VirtualBox VM. </para>
|
<para>Create a new VM in the VirtualBox UI with OS type <emphasis>Linux</emphasis> and Version <emphasis>Debian</emphasis> (32/64-bit according to the downloaded image). </para>
|
||||||
</listitem>
|
|
||||||
<listitem>
|
|
||||||
<para>When asked for a "Virtual Hard Disk" select the .vdi file you just extracted in step 1. </para>
|
|
||||||
</listitem>
|
|
||||||
<listitem>
|
|
||||||
<para>After a virtual machine is created, go to settings -> [Network] -> [Interface] and set on the following options. </para>
|
|
||||||
</listitem>
|
</listitem>
|
||||||
</orderedlist>
|
</orderedlist>
|
||||||
|
<para>
|
||||||
|
<inlinemediaobject>
|
||||||
|
<imageobject>
|
||||||
|
<imagedata fileref="images/virtualbox_os_type.png"/>
|
||||||
|
</imageobject>
|
||||||
|
<textobject>
|
||||||
|
<phrase>VirtualBox Name and OS dialog</phrase>
|
||||||
|
</textobject>
|
||||||
|
</inlinemediaobject>
|
||||||
|
</para>
|
||||||
|
<orderedlist numeration="arabic" inheritnum="ignore" continuation="restarts">
|
||||||
|
<listitem>
|
||||||
|
<para>In the <emphasis>Hard disk</emphasis> dialog choose <emphasis>Use an existing virtual hard disk file</emphasis> and select the .vdi file you extracted in step 1. </para>
|
||||||
|
</listitem>
|
||||||
|
</orderedlist>
|
||||||
|
<para>
|
||||||
|
<inlinemediaobject>
|
||||||
|
<imageobject>
|
||||||
|
<imagedata fileref="images/virtualbox_harddisk_file.png"/>
|
||||||
|
</imageobject>
|
||||||
|
<textobject>
|
||||||
|
<phrase>VirtualBox Hard disk dialog</phrase>
|
||||||
|
</textobject>
|
||||||
|
</inlinemediaobject>
|
||||||
|
</para>
|
||||||
|
<orderedlist numeration="arabic" inheritnum="ignore" continuation="restarts">
|
||||||
|
<listitem>
|
||||||
|
<para>When created, go to the virtual machine's Settings -> [Network] -> [Adapter 1]->[Attached to:] and choose the network type your want the machine to use according to the explanation in Network Configuration below. The recommended type is the <emphasis>Bridged adapter</emphasis> option, but be aware that this exposes the FreedomBox's services to your entire local network. </para>
|
||||||
|
</listitem>
|
||||||
|
</orderedlist>
|
||||||
|
<para>
|
||||||
|
<inlinemediaobject>
|
||||||
|
<imageobject>
|
||||||
|
<imagedata fileref="images/virtualbox_network_type.png"/>
|
||||||
|
</imageobject>
|
||||||
|
<textobject>
|
||||||
|
<phrase>VirtualBox recommended network setting</phrase>
|
||||||
|
</textobject>
|
||||||
|
</inlinemediaobject>
|
||||||
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
<section>
|
||||||
|
<title>First Boot</title>
|
||||||
|
<para>When satisfied with the VM settings click the start button in the VirtualBox UI and your new FreedomBox will boot. </para>
|
||||||
|
<para>The console of the VM will show the textual screen below when finished booting, from here most interaction with FreedomBox will be through the web interface (aka. <ulink url="https://wiki.debian.org/FreedomBox/Plinth#">Plinth</ulink>) in a browser. </para>
|
||||||
|
<para>
|
||||||
|
<inlinemediaobject>
|
||||||
|
<imageobject>
|
||||||
|
<imagedata fileref="images/virtualbox_console_after_boot.png"/>
|
||||||
|
</imageobject>
|
||||||
|
<textobject>
|
||||||
|
<phrase>FreedomBox console after booting successfully</phrase>
|
||||||
|
</textobject>
|
||||||
|
</inlinemediaobject>
|
||||||
|
</para>
|
||||||
|
<para>To access the web interface you need to find out your FreedomBox's IP address as described in section: Finding out the IP address of the virtual machine. Then access this IP from a web browser which is on the same network as the VM (f.ex. the host). If all is well, you are now presented with a welcome message and invited to complete the <emphasis>first boot</emphasis> process. </para>
|
||||||
|
<para>
|
||||||
|
<inlinemediaobject>
|
||||||
|
<imageobject>
|
||||||
|
<imagedata fileref="images/plinth_first_boot.png"/>
|
||||||
|
</imageobject>
|
||||||
|
<textobject>
|
||||||
|
<phrase>FreedomBox welcomes you to the first boot</phrase>
|
||||||
|
</textobject>
|
||||||
|
</inlinemediaobject>
|
||||||
|
</para>
|
||||||
|
<para>This mainly consist of creating an administrative user for the system. </para>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<title>Using</title>
|
||||||
|
<para>See the FreedomBox <ulink url="https://wiki.debian.org/FreedomBox/Use#">usage</ulink> page for more details. </para>
|
||||||
|
<para>You can log in to the Debian GNU/Linux system as the user created during Plinth first boot on the VirtualBox console or remotely via ssh. </para>
|
||||||
|
<para>After logging in, you can become root with the command <code>sudo su</code>. </para>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<title>Build Image</title>
|
||||||
|
<para>If you wish to build your own images instead of downloading available images, it can be done using <ulink url="https://wiki.debian.org/FreedomBox/Maker#">Freedom Maker</ulink>. </para>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<title>Tips & Troubleshooting</title>
|
||||||
<section>
|
<section>
|
||||||
<title>Network Configuration</title>
|
<title>Network Configuration</title>
|
||||||
<para>VirtualBox provides many types of networking options. Each has its advantages and disadvantages. For more information about how various networking types work in VirtualBox, see VirtualBox's networking documentation. <ulink url="https://www.virtualbox.org/manual/ch06.html"/> </para>
|
<para>VirtualBox provides many types of networking options. Each has its advantages and disadvantages. For more information about how various networking types work in VirtualBox, see VirtualBox's networking documentation. <ulink url="https://www.virtualbox.org/manual/ch06.html"/> </para>
|
||||||
@ -3262,13 +3512,13 @@ firewall-cmd --permanent --zone=internal --add-interface=eth0</screen>
|
|||||||
<para>What remains is to make those services available to the host machine or to other machines in the network. You must then choose one of the following types of networking for the network interface on your guest machine. To set a particular type of network for the guest's network adapter, go to the guest VM's settings then the network options and then select the adapter you wish to configure. There, set the network type from the available list of networks. </para>
|
<para>What remains is to make those services available to the host machine or to other machines in the network. You must then choose one of the following types of networking for the network interface on your guest machine. To set a particular type of network for the guest's network adapter, go to the guest VM's settings then the network options and then select the adapter you wish to configure. There, set the network type from the available list of networks. </para>
|
||||||
<orderedlist numeration="arabic" inheritnum="ignore" continuation="restarts">
|
<orderedlist numeration="arabic" inheritnum="ignore" continuation="restarts">
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>First and the recommended option is to use the <emphasis>Bridge</emphasis> type of network. This option exposes the guest machine to the same network that host network is connected to. The guest obtains network configuration information from a router or DHCP server on the network. The guest will appear as just another machine in the network. A major advantage of this of setup is that the host and all other machines in the network will be able to access the services provided by guest without requiring any further setup. The only drawback of this approach is that if the host is not connected to any network, the guest's network will remain unconfigured making it inaccessible even from the host. </para>
|
<para>First and the recommended option is to use the <emphasis>Bridged</emphasis> type of network. This option exposes the guest machine to the same network that host network is connected to. The guest obtains network configuration information from a router or DHCP server on the network. The guest will appear as just another machine in the network. A major advantage of this of setup is that the host and all other machines in the network will be able to access the services provided by guest without requiring any further setup. The only drawback of this approach is that if the host is not connected to any network, the guest's network will remain unconfigured making it inaccessible even from the host. </para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Second method is <emphasis>Host only</emphasis> type of networking. With a guest's network interface configured in this manner, it will only be accessible from the host machine. The guest will not able access any other machine but the host, so you do not have internet access on the guest. All services on the guest are available to the host machine without any configuration such as port forwarding. </para>
|
<para>Second method is <emphasis>Host only</emphasis> type of networking. With a guest's network interface configured in this manner, it will only be accessible from the host machine. The guest will not able access any other machine but the host, so you do not have internet access on the guest. All services on the guest are available to the host machine without any configuration such as port forwarding. </para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>The third option is to use the <emphasis>NAT</emphasis> type of network. This the networking type that VirtualBox assigns to a freshly created virtual machine. This option works even when host is not connected to any network. The guest is automatically configured and is able to access the Internet and local networks that host is able to connect to. However, the services provided by the guest require port forwarding configuration setup to be available outside. </para>
|
<para>The third option is to use the <emphasis>NAT</emphasis> type of network. This the networking type that VirtualBox assigns to a freshly created virtual machine. This option works even when host is not connected to any network. The guest is automatically configured and is able to access the internet and local networks that host is able to connect to. However, the services provided by the guest require port forwarding configuration setup to be available outside. </para>
|
||||||
<para>To configure this go to VM settings -> [Network] -> [Adapter] -> [Port Forwarding]. Map a port such as 2222 from host to guest port 22 and you will be able to ssh into FreedomBox from host machine as follows: </para>
|
<para>To configure this go to VM settings -> [Network] -> [Adapter] -> [Port Forwarding]. Map a port such as 2222 from host to guest port 22 and you will be able to ssh into FreedomBox from host machine as follows: </para>
|
||||||
<screen format="linespecific"> ssh -p 2222 fbx@localhost</screen>
|
<screen format="linespecific"> ssh -p 2222 fbx@localhost</screen>
|
||||||
<para>Map 4443 on host to 443 on the guest. This make FreedomBox HTTPS service available on host using the URL <ulink url="https://localhost:4443/"/> You will need to add a mapping for each such services from host to guest. </para>
|
<para>Map 4443 on host to 443 on the guest. This make FreedomBox HTTPS service available on host using the URL <ulink url="https://localhost:4443/"/> You will need to add a mapping for each such services from host to guest. </para>
|
||||||
@ -3589,22 +3839,12 @@ firewall-cmd --permanent --zone=internal --add-interface=eth0</screen>
|
|||||||
</tgroup>
|
</tgroup>
|
||||||
</informaltable>
|
</informaltable>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
|
||||||
<title>Using</title>
|
|
||||||
<para>You can log in as the user created during Plinth setup. </para>
|
|
||||||
<para>After logging in, you can become root with the command <code>sudo su</code>. See the FreedomBox <ulink url="https://wiki.debian.org/FreedomBox/Use#">usage</ulink> page for more details. </para>
|
|
||||||
</section>
|
|
||||||
<section>
|
|
||||||
<title>Build Image</title>
|
|
||||||
<para>If you wish to build your own images instead of downloading available images, it can be done using <ulink url="https://wiki.debian.org/FreedomBox/Maker#">Freedom Maker</ulink>. </para>
|
|
||||||
</section>
|
|
||||||
<section>
|
|
||||||
<title>Tips & Troubleshooting</title>
|
|
||||||
<section>
|
<section>
|
||||||
<title>Finding out the IP address of the virtual machine</title>
|
<title>Finding out the IP address of the virtual machine</title>
|
||||||
<para>This depends on the network configuration you chose. With a <emphasis>bridged adapter</emphasis>, your virtual machine gets its IP address from the DHCP server of your network, most likely of your Router. You can try the first couple of IP addresses or check your router web interface for a list of connected devices. </para>
|
<para>This depends on the network configuration you chose. With a <emphasis>bridged adapter</emphasis>, your virtual machine gets its IP address from the DHCP server of your network, most likely of your Router. You can try the first couple of IP addresses or check your router web interface for a list of connected devices. </para>
|
||||||
<para>If you chose <emphasis>host-only adapter</emphasis>, the IP address is assigned by the DHCP server of your VirtualBox network. In the VirtualBox Manager, go to File -> Preferences -> Network -> Host-only Networks. You can see and edit the DHCP address range there, typically you get assigned addresses close to the <emphasis>Lower Address Bound</emphasis>. </para>
|
<para>If you chose <emphasis>host-only adapter</emphasis>, the IP address is assigned by the DHCP server of your VirtualBox network. In the VirtualBox Manager, go to File -> Preferences -> Network -> Host-only Networks. You can see and edit the DHCP address range there, typically you get assigned addresses close to the <emphasis>Lower Address Bound</emphasis>. </para>
|
||||||
<para>Another possibility of finding the IP address is to login via the Virtualbox Manager (or similar software). The FreedomBox images do not have any default user accounts, so you need to set an initial user and password using the <ulink url="https://github.com/freedombox/freedom-maker/blob/master/bin/passwd-in-image">passwd-in-image script</ulink>. </para>
|
<para>Another possibility of finding the IP address is to login via the Virtualbox Manager (or similar software). The FreedomBox images do not have any default user accounts, so you need to set an initial user and password using the <ulink url="https://github.com/freedombox/freedom-maker/blob/master/bin/passwd-in-image">passwd-in-image script</ulink>. </para>
|
||||||
|
<para>See also <ulink url="https://wiki.debian.org/FreedomBox/Manual/QuickStart#">QuickStart</ulink> for instructions on how to scan your network to discover the IP of the VM. </para>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<title>Networking Problems with macchanger</title>
|
<title>Networking Problems with macchanger</title>
|
||||||
@ -3696,7 +3936,7 @@ $ sudo reboot</screen>
|
|||||||
<para>Freedombox does not support network device configuration via <code>/etc/network/interfaces</code>, and it will not manage any non-loopback interfaces mentioned there. (See <ulink url="https://bugs.debian.org/797614">bug #797614</ulink>.) Future versions of freedombox-setup will clear this file automatically; for now, edit it manually and ensure that it contains only the following: </para>
|
<para>Freedombox does not support network device configuration via <code>/etc/network/interfaces</code>, and it will not manage any non-loopback interfaces mentioned there. (See <ulink url="https://bugs.debian.org/797614">bug #797614</ulink>.) Future versions of freedombox-setup will clear this file automatically; for now, edit it manually and ensure that it contains only the following: </para>
|
||||||
<screen format="linespecific">auto lo
|
<screen format="linespecific">auto lo
|
||||||
iface lo inet loopback</screen>
|
iface lo inet loopback</screen>
|
||||||
<para>If you have already completed the setup process without doing this step, you will need to clear out the <code>/etc/network/interfaces</code> file keeping only the above lines. Then perform a reboot. After this network connections configured by the <code>setup</code> step above will configure your network. Network interfaces will then be in the <code>internal</code> or <code>external</code> firwall zone. This is essential for the FreedomBox's web interface to be reachable from other machines in the network. You can tweak network manager connections with the <code>nmtui</code> command if you wish. </para>
|
<para>If you have already completed the setup process without doing this step, you will need to clear out the <code>/etc/network/interfaces</code> file keeping only the above lines. Then perform a reboot. After this network connections configured by the <code>setup</code> step above will configure your network. Network interfaces will then be in the <code>internal</code> or <code>external</code> firewall zone. This is essential for the FreedomBox's web interface to be reachable from other machines in the network. You can tweak network manager connections with the <code>nmtui</code> command if you wish. </para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</orderedlist>
|
</orderedlist>
|
||||||
</section>
|
</section>
|
||||||
@ -4158,7 +4398,8 @@ wget https://www.thinkpenguin.com/files/ath9k_firmware_free-version/htc_7010.fw<
|
|||||||
<para>Individual applications that FreedomBox exposes to users such as ownCloud, JWChat etc. </para>
|
<para>Individual applications that FreedomBox exposes to users such as ownCloud, JWChat etc. </para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
<para>Some of the translation work are implemented in user interface (Plinth) since the 0.7 release. Documents for user interface translation are currently available on <ulink url="https://www.transifex.com/freedombox/">Transifex localization platform</ulink> and <ulink url="https://github.com/freedombox/Plinth/tree/master/locale">GitHub</ulink>. If you wish to see FreedomBox available for one of your languages, please start a discussion on the FreedomBox discuss <ulink url="http://lists.alioth.debian.org/mailman/listinfo/freedombox-discuss">mailing list</ulink> or on the <ulink url="irc://irc.debian.org/freedombox">#freedombox IRC</ulink> channel to avoid double translations. </para>
|
<para>The primary user interface (Plinth) was internationalized in the <ulink url="https://wiki.debian.org/FreedomBox/ReleaseNotes/ReleaseNotesDev#Version_0.7_.282015-12-13.29">0.7 release</ulink>. You can contribute to the localization effort using the web-based tool at <ulink url="https://hosted.weblate.org/projects/freedombox/">Weblate</ulink> or directly to the source tree via <ulink url="https://github.com/freedombox/Plinth/tree/master/locale">GitHub</ulink>. </para>
|
||||||
|
<para>If you wish to see FreedomBox available for one of your languages, please start a discussion on the FreedomBox discuss <ulink url="http://lists.alioth.debian.org/mailman/listinfo/freedombox-discuss">mailing list</ulink> or on the <ulink url="irc://irc.debian.org/freedombox">#freedombox IRC</ulink> channel to avoid double translations. </para>
|
||||||
<para>For more information, please visit the FreedomBox <ulink url="https://wiki.debian.org/FreedomBox/Translate#">translation landing page</ulink>. </para>
|
<para>For more information, please visit the FreedomBox <ulink url="https://wiki.debian.org/FreedomBox/Translate#">translation landing page</ulink>. </para>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
|
|||||||
BIN
doc/images/freedombox2.png
Normal file
BIN
doc/images/freedombox2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 78 KiB |
BIN
doc/images/plinth_first_boot.png
Normal file
BIN
doc/images/plinth_first_boot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 83 KiB |
BIN
doc/images/virtualbox_console_after_boot.png
Normal file
BIN
doc/images/virtualbox_console_after_boot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
BIN
doc/images/virtualbox_harddisk_file.png
Normal file
BIN
doc/images/virtualbox_harddisk_file.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 100 KiB |
BIN
doc/images/virtualbox_network_type.png
Normal file
BIN
doc/images/virtualbox_network_type.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 77 KiB |
BIN
doc/images/virtualbox_os_type.png
Normal file
BIN
doc/images/virtualbox_os_type.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 83 KiB |
Loading…
x
Reference in New Issue
Block a user