diff --git a/sphinx-docs/installguide/install_linux.rst b/sphinx-docs/installguide/install_linux.rst index b8ad6dd486..dd9fe898b3 100644 --- a/sphinx-docs/installguide/install_linux.rst +++ b/sphinx-docs/installguide/install_linux.rst @@ -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 diff --git a/sphinx-docs/installguide/install_mac.rst b/sphinx-docs/installguide/install_mac.rst index 6dc14618c1..d185d7c567 100644 --- a/sphinx-docs/installguide/install_mac.rst +++ b/sphinx-docs/installguide/install_mac.rst @@ -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. + diff --git a/sphinx-docs/installguide/install_main.rst b/sphinx-docs/installguide/install_main.rst index e38b055d7c..be3ddec424 100644 --- a/sphinx-docs/installguide/install_main.rst +++ b/sphinx-docs/installguide/install_main.rst @@ -8,4 +8,4 @@ Hello! If you know what OS you're installing on then click ahead. Windows Installation Guide Mac Installation Guide Linux Installation Guide - Raspberry Pi + Raspberry Pi diff --git a/sphinx-docs/installguide/install_rasp_pi.rst b/sphinx-docs/installguide/install_rasp_pi.rst index 05a12c92a8..c0484da418 100644 --- a/sphinx-docs/installguide/install_rasp_pi.rst +++ b/sphinx-docs/installguide/install_rasp_pi.rst @@ -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 \ No newline at end of file diff --git a/sphinx-docs/installguide/install_windows.rst b/sphinx-docs/installguide/install_windows.rst index 17c5daae63..65926f408d 100644 --- a/sphinx-docs/installguide/install_windows.rst +++ b/sphinx-docs/installguide/install_windows.rst @@ -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. + diff --git a/sphinx-docs/installguide/rasp_pi.rst b/sphinx-docs/installguide/rasp_pi.rst deleted file mode 100644 index ca77ccd84d..0000000000 --- a/sphinx-docs/installguide/rasp_pi.rst +++ /dev/null @@ -1,3 +0,0 @@ -Raspberry Pi -============================ -If you haven't eaten that raspberry pie.... diff --git a/sphinx-docs/installguide/subtopic.rst b/sphinx-docs/installguide/subtopic.rst deleted file mode 100644 index 8c225eddce..0000000000 --- a/sphinx-docs/installguide/subtopic.rst +++ /dev/null @@ -1,3 +0,0 @@ -A subtopic -==== -What a wonderful page. diff --git a/sphinx-docs/installguide/topic1.rst b/sphinx-docs/installguide/topic1.rst deleted file mode 100644 index 1452cdaf0b..0000000000 --- a/sphinx-docs/installguide/topic1.rst +++ /dev/null @@ -1,8 +0,0 @@ -Topic 1 -==== -Very interesting topic! - -.. toctree:: - :maxdepth: 2 - - subtopic diff --git a/sphinx-docs/make.bat b/sphinx-docs/make.bat new file mode 100644 index 0000000000..37f35bd499 --- /dev/null +++ b/sphinx-docs/make.bat @@ -0,0 +1,242 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +set I18NSPHINXOPTS=%SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over all changed/added/deprecated items + echo. xml to make Docutils-native XML files + echo. pseudoxml to make pseudoxml-XML files for display purposes + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + + +%SPHINXBUILD% 2> nul +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\KALite.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\KALite.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdf" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdfja" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf-ja + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +if "%1" == "xml" ( + %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The XML files are in %BUILDDIR%/xml. + goto end +) + +if "%1" == "pseudoxml" ( + %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. + goto end +) + +:end