RPi Guides

Introduction
This page contains a set of guides to show readers how to do common or useful tasks on the system. These guides focus on system-related items such as how to install a linux option or configure an on-board device. Items listed here should achieve a goal as simply as possible, with the aim to build the confidence of the reader. For anything more complex, the item should be listed on the projects page.

The Raspberry Pi Forum has a list of Project Ideas & Links, to help people get started.

Please add links to your guides (and ones you find interesting).

Fill in each section:
 * Guide Title (as a link to the project webpage or connected wiki page)
 * Guide Description (including any additional links or information
 * Tags (key words related to the item, i.e. LCD Screen, Teaching, Python)
 * Author(s) or group who have produced it (also if it is an Open/Community Project for anyone to contribute)
 * Guide Status (Not Started/In-Progress/Available).

System Tasks
This section describes tasks that involve software installation, setup or configuration of your Raspberry Pi. {| border="1" style="background:transparent;" Guide Title and Link Guide Description Tags Author Status
 * style="width:15%; vertical-align:top; border:1px solid #aaa;" |
 * style="width:40%; vertical-align:top; border:1px solid #aaa;" |
 * style="width:7%; vertical-align:top; border:1px solid #aaa;" |
 * style="width:10%; vertical-align:top; border:1px solid #aaa;" |
 * style="width:7%; vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Setting up an SD card
How to set up an SD card with an OS image Linux, OS, Raspbian, SD card Ben Elgar - CPD for Teachers Complete and Tested
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Debian Auto Login/Startx
How to launch LXDE without the need of a username/Password in Debian. LXDE, Boot, Login, Auto Ian Hartwell (helpme1986) Early draft.
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |

Defining default LXTerminal size on the Raspberry Pi

 * The LXTerminal application starts with a default size of 24 rows and 80 columns. The window can be resized, but this setting is not remembered for the next time you create a window. This guide shows how to make the setting persistent.
 * LXTerminal size
 * HBrydon
 * Complete


 * vertical-align:top; border:1px solid #aaa;" |

Installing Chromium web browser
Installing the Chromium web browser on Debian. Chromium bredman Ready for testing
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |

Installing The Java JDK on the Raspberry Pi (Debian systems only)

 * This page describes how to to install the Java 7 JDK on Debian Wheezy. [As of Q1 2013, the Java JDK will only run on soft-float implementations of Debian Wheezy.]
 * Java JDK
 * HBrydon
 * Complete
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |

Installing Mozilla IceWeasel Web Browser

 * On the Raspberry Pi, the Mozilla Firefox browser is implemented under the name "IceWeasel". This page lists how to install IceWeasel on Raspian and Debian.
 * Mozilla IceWeasel
 * HBrydon
 * Debian: Complete Raspian: Needs testing
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |

Raspberry Pi and real-time, low-latency audio
The Raspberry Pi can be set up to handle real-time, low-latency audio but it requires quite some tweaking. Hence this Wiki article in which some common bottlenecks as well as some possible optimizations will be described. Last but not least this article will explain how to get JACK aka jackd running on your RPi. realtime real-time jackd low-latency audio midi Jeremy Jongepier (AutoStatic) Almost complete Raspbian: tested
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * }
 * }

Easy
Suitable for beginners who are confident typing commands into Linux but need a lot of guidance. {| border="1" style="background:transparent;" Guide Title and Link Guide Description Tags Author Status
 * style="width:15%; vertical-align:top; border:1px solid #aaa;" |
 * style="width:40%; vertical-align:top; border:1px solid #aaa;" |
 * style="width:7%; vertical-align:top; border:1px solid #aaa;" |
 * style="width:10%; vertical-align:top; border:1px solid #aaa;" |
 * style="width:7%; vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |

Network Attached Storage
Network Attached Storage - Basic concept: A place to save copies of all your important files Samba bredman - Open Project Tested on Debian, some help needed with Fedora chapter
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |

Connect your RPi to your MS Windows machines
The guide above is a full NAS setup - This guide/script just configures and installs a very simple setup to allow you to read/write to your RPi files Samba Simon Walters - Open Project Tested on Raspbian
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |

Python 3 on Debian
Installing the latest Python 3 and common modules on Debian. Python croston Tested. Needs more modules adding
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Installing Java 8
Installing Java 8 on Raspberry Pi. Java 8 Happy-Neko Tested on Raspbian.
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

iTunes music server (forked-daapd)
How to install forked-daapd, an iTunes music server Debian, streaming, Greg (pr1sm)/ejurgensen Tested on Raspbian
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Setting up a static IP in Debian
How to set-up a static IP in Debian Debian, Static IP sleepy Available
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Setting up static IP (2)
Alternative guide to setting-up a static IP Debian, Static IP Andrum99 Unknown
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Using the serial port
Connecting the serial port on your Raspberry Pi Serial, GPIO, Console Open project Nearing completion
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Text to Speech (Speech Synthesis)
Three easy methods of getting your Raspberry Pi to talk Raspbian StevenP Works fine
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Installing a Web Cam
Basic installation and testing of a usb web cam on Raspberry Pi web cam, ps eye, ffmpeg Chris Cummings Works
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

RaPiRo Web Control
Basic installation and testing of a webserver controlling RaPiRo on Raspberry Pi webserver, python, serial controll Jaix Bly Works
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * }
 * }

Medium
Suitable for beginners who are willing to experiment and only need a little guidance. {| border="1" style="background:transparent;" Guide Title and Link Guide Description Tags Author Status
 * style="width:15%; vertical-align:top; border:1px solid #aaa;" |
 * style="width:40%; vertical-align:top; border:1px solid #aaa;" |
 * style="width:7%; vertical-align:top; border:1px solid #aaa;" |
 * style="width:10%; vertical-align:top; border:1px solid #aaa;" |
 * style="width:7%; vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |

Classroom Boot Server
Classroom boot server - Basic concept: A PXE server to allow cheap computers without hard disks to boot into Windows or Linux. PXE, netboot bredman - Open Project Lots of random text, needs organisation and testing
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Installing Ruby on Rails
Installing Ruby on Rails and common modules on Debian. Ruby, Rails Erik Partially tested. Still early draft.
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Share your screen with VNC
Installing Vino to allow remote control of the screen from another computer. Vino, VNC Jaix Bly Draft.
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Remote Control of a Raspberry with VNC
Installing VNC to allow remote control a X11 session (not the console) from another computer. VNC Simon H Early draft.
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Remote Destop Server for Raspberry
Installing XRDP to allow Remote Desktop / Terminal Server on Raspberry Pi. rdp, xrdp Jaix Bly Draft.
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

iSCSI support and boot
Adding iSCSI initiator/target support, setting up iSCSI initiator, and configuring booting from an iSCSI volume. iSCSI, netboot Alex (nidO) Early draft, tested
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Send email containing Pi ip address on boot
Send email containing the ip of your Pi so you can access via SSH or other network protocol when your ip changes (moving networks) and you are working headless SSH, email, python --Geraldcor 03:36, 18 June 2012 (UTC) Early draft, tested
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Connecting securely to TightVNC over the Internet
Guide to installing Tightvnc server on the Raspberry Pi and securing it using ssh to allow connecting over the Internet. VNC, ssh Stewart Watkiss Available
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Configuring a LAMP webserver
Guide to configuring the Raspberry Pi as a LAMP (Linux, Apache, Mysql, PHP) webserver. apache, mysql, php Stewart Watkiss Available
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Storage Filer/NAS via Chef
Turn-key package to turn a machine into a storage filer / NAS. Developed and tested on a RaspberryPi. Still in early development. Deploys with Chef. samba, nfs, chef Eric Windisch Alpha/early-stage
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Raspberry Pi WiFi Hotspot
Turn your Raspberry Pi into a WiFi hotspot! wifi, hotspot, hostapd Isaac Smith Works like a charm.
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Raspberry Pi / Arduino Serial Communication
Raspberry Pi talking to Arduino over serial uart arduino, serial, uart Chris Cummings Works perfectly!
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Using the camera module in c++
Installation and tutorial on using a very simple api to access the Pi Camera Module in C++ camera, c++ Chris Cummings Works
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * }

Advanced
Suitable for confident users who want to try something more advanced. {| border="1" style="background:transparent;" Guide Title and Link Guide Description Tags Author Status
 * style="width:15%; vertical-align:top; border:1px solid #aaa;" |
 * style="width:40%; vertical-align:top; border:1px solid #aaa;" |
 * style="width:7%; vertical-align:top; border:1px solid #aaa;" |
 * style="width:10%; vertical-align:top; border:1px solid #aaa;" |
 * style="width:7%; vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |

building and installing OpenELEC
How to build and install OpenELEC,a embedded Multimedia Distro. You can learn (cross)compiling, building packages from source, how buildsystems are working and what is needed to install a OS on a SD-card for Raspberry Pi. XBMC, HTPC, Multimedia, Distro, compiling Stephan Raue Available
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |

Using Skypekit
How to get started using Skypekit to make calls & chat. This is currently only useful for advanced users & developers. Skype, Skypekit Henry Cooke Alpha.
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Pre-configuring SD card with a static IP address
Guide to pre-configuring a SD image so that it boots with a static IP address. Useful for running headless without needing to know what DHCP address will be allocated. networking, tcpip Stewart Watkiss Available
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |


 * vertical-align:top; border:1px solid #aaa;" |

Sending remote commands to our Pi thanks to Pastebin
A guide to send remote commands to our Pi just by editing a pastebin! remote commands, notsureifuseful Itxaka Serrano Garcia Available
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * vertical-align:top; border:1px solid #aaa;" |
 * }
 * }

=References=