Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the Install Guides and put in some hyperlinks to make it cleaner... #5

Merged
merged 4 commits into from
Feb 10, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions sphinx-docs/installguide/install_linux.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
Linux Installation Guide
===========================
What a wonderful page. hELLO WELCOME YOU WILL LEARN HAO 2 INSTALL HERE
.. note:: You will need to make sure *sudo* is installed for both Debian and Ubuntu. These commands can then be used for both operating systems.

#. Check if Python is already installed with *python -V*.
#. If not already installed or outdated, install Python v2.6 (*sudo apt-get install python2.6*) or v2.7 (*sudo apt-get install python2.7*).
* Or use your Distro's Package Manager by searching for *Python*.
#. If not already installed or outdated, install Git with *apt-get install git-core*.
* Or use your Distro's Package Manager by searching for *Git*.
#. Switch to the directory in which you wish to install KA-Lite.
#. Enter *git clone https://github.com/learningequality/ka-lite.git* to download KA Lite.
#. Switch into the newly downloaded ka-lite directory
#. Run the install script with *./setup_unix.sh*.
#. **IF** you want the server to start automatically in the background after your server starts then:
* Setup the server (one time) to automatically run in the background
* Enter *sudo ./runatboot.sh* in the terminal from inside the ka-lite/kalite directory
* Use *sudo service kalite stop* to stop the server
* OR *sudo service kalite start* to start the server.
#. **IF** the automatic background option was not chosen, start the server by running *./start.sh* in the ka-lite directory.
#. KA Lite should be accessible from http://127.0.0.1:8008/
* Replace *127.0.0.1* with the computer's external IP address or domain name to access it from another computer.

TEST

31 changes: 8 additions & 23 deletions sphinx-docs/installguide/install_mac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,43 +3,28 @@ Mac Installation Guide

Macintosh installation uses the command line, but if you follow the instructions carefully, you should have no problem installing KA Lite.

#. Download and install the latest Python for Mac: https://www.python.org/downloads

#. Download and install either Python2.6_ or Python2.7_ for Mac
.. _Python2.6: https://www.python.org/download/releases/2.6/
.. _Python2.7: https://www.python.org/download/releases/2.7/
#. You need to open the Terminal app. There are many ways to do this. We suggest the following:

* Click the magnifier icon on the upper right corner and search "terminal".

* Press *'Enter'* with the "Terminal" app selected and it should open.

#. In the Terminal, enter *Python -V* and press *'Enter'*. **The version number should reflect the Python version you just installed.**

#. KA Lite uses Git to distribute it's code for non-Windows operating systems.

* Proceed to Git's website (http://git-scm.com/downloads) to download and install if you don't have it already.

#. Create the folder where you would like to install KA Lite.

* Proceed to the Git_ website to download and install if you don't have it already.
.. _Git: http://git-scm.com/downloads
#. Create the folder where you would like to install KA Lite.
* In the Terminal, type *cd* and then drag the folder you created into the Terminal.

* This will copy the path name into the Terminal window.

* Press *'Enter'*.

#. Now you can copy and paste this command into the terminal and press *'Enter'*.

* *git clone https://github.com/learningequality/ka-lite.git*

#. Once it finishes downloading, enter *cd ka-lite* to move into the folder that was just downloaded.

#. To begin installation enter *./setup_mac.command*

#. During installation, you will be prompted to make an Admin account. Go ahead and follow along with the instructions.

#. To begin running the server.

* Enter *./start.command*

* Enter *./start.command*
#. KA lite should be accessible from http://127.0.0.1:8008/

* Replace *127.0.0.1* with the computer's external IP address or domain name to access it from another computer.


2 changes: 1 addition & 1 deletion sphinx-docs/installguide/install_main.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Hello! If you know what OS you're installing on then click ahead.
Windows Installation Guide <install_windows>
Mac Installation Guide <install_mac>
Linux Installation Guide <install_linux>
Raspberry Pi <rasp_pi>
Raspberry Pi <install_rasp_pi>
68 changes: 67 additions & 1 deletion sphinx-docs/installguide/install_rasp_pi.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,69 @@
Raspberry Pi Installation Guide
================================
If you haven't eaten that raspberry pie....
Please follow *steps 1-8* for normal Linux Installation Guide.

During installation you will be asked to optimize your installation for performance on the Raspberry Pi.

Say **YES!** Make sure you have a stable Internet connection during the process, as you will be downloading a number of 3rd party open source libraries.

Raspberry Pi Wi-Fi
------------------------------
.. note:: Two Wi-Fi USB modules have been tested with KA Lite on the Raspberry Pi

* Raspberry Pi WiPi adaptor
* Edimax EW-7811Un
In our tests, we found that the WiPi adaptor supported a higher number tablet connections.

Installation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. note:: The Raspberry Pi may crash if the USB adaptor is inserted or removed while the computer is switched on.

* Make sure to shutdown and remove the power from the Raspberry Pi.
* Afterwards, insert the wireless USB adaptor.
* Lastly, switch the Raspberry Pi on.

#. Make sure the Raspberry Pi operating system is up-to-date.
* Login with the account used to install KA Lite
* Update the Raspberry Pi operating system by:
* *sudo apt-get update*
* *sudo apt-get upgrade*
#. Get the installation scripts.
* *cd /opt*
* *sudo git clone https://github.com/learningequality/ka-lite-pi-scripts.git*
#. Install and configure the access point.
* *cd /opt/ka-lite-pi/scripts*
* *sudo ./configure.sh*
.. note:: If using the Edimax EW-7811UN, ignore the "hostapdSegmentation fault" error.
#. Install the USB adaptor software.
* If using the WiPi, run this command:
* *cd /opt/ka-lite-pi-scripts*
* *sudo ./use_wipi.sh*
* If using the Edimax EW-7811Un, run this command:
* *cd /opt/ka-lite-pi/scripts*
* *sudo ./use_edimax*
#. Complete the access point configuration
* *sudo python ./configure_network_interfaces.py*
* *sudo insserv hostapd*
* *sudo nano /etc/default/ifplugd*
#. Amend these two settings:
...

INTERFACES="eth0"
HOTPLUG_INTERFACES="eth0"

...
#. Set wireless to start automatically
* *sudo nano /etc/network/interfaces*
* Add the "auto wlan0" option and save the file
...

auto wlan0
iface wlan0 inet static
address 1.1.1.1

...
#. Finally
* *sudo reboot*
* A wireless network named "kalite" should be available.
* Connect to this network
* If the KA Lite server is started, browse to 1.1.1.1
4 changes: 3 additions & 1 deletion sphinx-docs/installguide/install_windows.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
Windows Installation Guide
===========================

#. Download the KA Lite Windows installer: https://learningequality.org/downloads/KALiteSetup-0.12.10.exe
#. Download the KA Lite Windows_ installer
.. _Windows: https://learningequality.org/downloads/KALiteSetup-0.12.10.exe

#. After downloading the .exe file, double click it. A window will appear and guide you through the process of installing KA Lite on the server.



3 changes: 0 additions & 3 deletions sphinx-docs/installguide/rasp_pi.rst

This file was deleted.

3 changes: 0 additions & 3 deletions sphinx-docs/installguide/subtopic.rst

This file was deleted.

8 changes: 0 additions & 8 deletions sphinx-docs/installguide/topic1.rst

This file was deleted.

Loading