SAIN3 "Sphinx + LAMP + Webmin" Package (HVM)

User Guide

 

1.Sphinx Documentation Generator

As an outstanding documentation generator, Sphinx makes it easy to create orderly, intelligent and beautiful documentation.

Sphinx is created for documentation and not for blog. Though Sphinx is not as operationally convenient as blog for common users, it works better than blog in the case that a number of documentation needs to be edited and in order.

 

2.Webmin

Webmin is a web-based system configuration tool for Unix-like systems. With it, it is possible to configure operating system internals, such as users, disk quotas, services or configuration files, as well as modify and control open source apps. If you want to manage Apache & MySQL through the Web page, Webmin is the right tool for you.

 

 

Usage instructions

 

** Important Info **

Before you start to access the system, please make sure the "Status Checks" of the instance in AWS Console turns to "2/2 checks passed", or the initialization process might be interrupted and fails. It takes about 5-10 mins.

 

** Default Settings **

1.Webmin / MySQL:

Username: root

Password: <instance ID>

 

** Access the System **

1. Visit your Sphinx.

http://<public DNS>

2. Visit Webmin.

http://<public DNS>:10000

Username: root, password: <instance ID>.

3. You can manage MySQL through Webmin.

Login to webmin -> Servers -> MySQL Database Server.

Username: root, password: <instance ID>.

 

Replace the <public DNS> above with the actual IP address of the running EC2 instance.

 

** Support **

1. Sphinx Documentation Generator Website

http://sphinx-doc.org/

2. Sphinx Documentation Generator Examples

http://sphinx-doc.org/examples.html

3. Sphinx Documentation

http://sphinx-doc.org/contents.html

4. (Helpful) reStructuredText (reST) Concepts and Syntax

http://sphinx-doc.org/rest.html

 

** Quick Start **

Here is a brief summary for generating your documentation.

1. Create your source files (.rst) in directory /var/www and make sure all files are in place.

Before you try to compose the source files (.rst), you should understand the reStructuredText (reST) syntax. See http://sphinx-doc.org/rest.html for reStructuredText concepts and syntax. For your information, we have configured the documentation as an example. Use the “Show Source” link in the sidebar to look at the source for the document as you are viewing the HTML version.

 

2. Open a terminal or SSH client, using your Amazon EC2 SSH public key, SSH into the instance as the ``ubuntu`` user using the public IP for your instance.

Use the command ``sudo make html`` in /var/www via SSH.

 

** Cannot Access to Webmin **

1. After the "Status Checks" of the instance in AWS Console turns to "2/2 checks passed" can you start to access the system, or the initialization process might be interrupted and fails.

2.Make sure port 10000 is in your security group.

Type: Custom TCP Rule

Protocol: TCP

Port range: 10000

Source: 0.0.0.0/0