improve document ・ 31fc1be ・ Gitprep

+98 -97

README.md

@@ -14,101 +14,6 @@ Github clone. You can install portable github system into Unix/Linux.
 * CGI support, built-in web server, and reverse proxy support.
 * SSL support.
 
-# Installation into Shared Server
-
-Shared Server must support **Linux/Unix**, **Apache**, **SuExec**,
-**CGI**, and **PHP5(CGI mode)**.
-
-(*PHP* is not strictly necessary. If PHP exists, the install process is easy
-because you do not need to think about permissions.)
-
-Many shared servers support these, so you will be able to find or setup a suitable server easily.
-
-## Download
-
-First you need to [download gitprep](https://github.com/yuki-kimoto/gitprep/archive/latest.zip).
-
-Expand the zip file. You will see the following directory:
-
-    gitprep-latest
-
-Rename the gitprep-latest directory to gitprep.
-
-    gitprep-latest -> gitprep
-
-If you know latest gitprep release, I inform you in the following blog
-or mailing list.
-
-[Yuki Kimoto Perl Blog](http://blogs.perl.org/users/yuki_kimoto/)
-
-[Google GitPrep Group](https://groups.google.com/forum/#!forum/gitprep)
-
-## Configuration
-
-GitPrep needs the git command. You must install git by yourself.
-If you haven't set user.name and user.email, you must set them.
-
-    git config --global user.name "gitprep"
-    git config --global user.email "gitprep@example.com"
-
-You must add the correct git command path to the **gitprep.conf** config file.
-
-    [basic]
-    ;;; Git command path
-    git_bin=/home/yourname/local/bin/git
-
-## Upload Server by FTP
-
-You should upload these directories into server document root by FTP.
-
-## Setup
-
-Access the following URL by browser:
-
-    http://(Your host name)/gitprep/setup/setup.php
-
-If you don't access PHP file or don't have PHP,
-you can use CGI script. Please set this CGI script permission to `755`.
-
-    http://(Your host name)/gitprep/setup/setup.cgi
-
-Click the Setup button once and wait about 5 minutes.
-
-## Go to application
-
-If you see the result screen, click "Go to Application".
-
-## Getting started
-
-On a fresh install, you will be asked to create the admin user.
-
-Log in as the admin user, then create a new regular user.
-
-Logout and log in as the regular user. Create repos and use the system!
-
-Note: the admin user cannot create repos.
-
-## Importing data
-
-One way to import data:
-
-1. Create your new repo in gitprep.
-2. In your local git repo, add a new remote target: 
-```
-git remote add gitprep git@my.gitprep.server:new-repo.git 
-```
-3. Push all your repo content up in to this new gitprep target.
-4. Update your local git repo config such that gitprep is now the origin.
-
-Copy from `/var/lib/gitolite` or `/var/lib/gitosis`
-
-TBD
-
-## Internal Server Error
-
-If you receive an internal server error, look at the log file (gitprep/log/production.log)
-to see what problem has occurred.
-
 # Installation into own Unix/Linux Server
 
 GitPrep has its own web server,
@@ -154,7 +59,17 @@ If "All tests successful" is shown, the setup process was successful.
 
 ## Configuration
 
-Same as Shared Server's Configuration section.
+GitPrep needs the git command. You must install git by yourself.
+If you haven't set user.name and user.email, you must set them.
+
+    git config --global user.name "gitprep"
+    git config --global user.email "gitprep@example.com"
+
+You must add the correct git command path to the **gitprep.conf** config file.
+
+    [basic]
+    ;;; Git command path
+    git_bin=/home/yourname/local/bin/git
 
 ## Operation
 
@@ -225,7 +140,93 @@ If you have git, it is easy to install from git.
 
 It is useful to write configuration in ***gitprep.my.conf***, not gitprep.conf.
 
-## FAQ
+# Installation into Shared Server
+
+Shared Server must support **Linux/Unix**, **Apache**, **SuExec**,
+**CGI**, and **PHP5(CGI mode)**.
+
+(*PHP* is not strictly necessary. If PHP exists, the install process is easy
+because you do not need to think about permissions.)
+
+**Note that CGI script only work on shared server which support CGI + SuExec.
+At first, you should check the shared server support CGI + SuExec.**
+
+## Download
+
+First you need to [download gitprep](https://github.com/yuki-kimoto/gitprep/archive/latest.zip).
+
+Expand the zip file. You will see the following directory:
+
+    gitprep-latest
+
+Rename the gitprep-latest directory to gitprep.
+
+    gitprep-latest -> gitprep
+
+If you know latest gitprep release, I inform you in the following blog
+or mailing list.
+
+[Yuki Kimoto Perl Blog](http://blogs.perl.org/users/yuki_kimoto/)
+
+[Google GitPrep Group](https://groups.google.com/forum/#!forum/gitprep)
+
+## Configuration
+
+Same as "Installation into own Unix/Linux Server" Configuration section.
+
+## Upload Server by FTP
+
+You should upload these directories into server document root by FTP.
+
+## Setup
+
+Access the following URL by browser:
+
+    http://(Your host name)/gitprep/setup/setup.php
+
+If you don't access PHP file or don't have PHP,
+you can use CGI script. Please set this CGI script permission to `755`.
+
+    http://(Your host name)/gitprep/setup/setup.cgi
+
+Click the Setup button once and wait about 5 minutes.
+
+## Go to application
+
+If you see the result screen, click "Go to Application".
+
+## Getting started
+
+On a fresh install, you will be asked to create the admin user.
+
+Log in as the admin user, then create a new regular user.
+
+Logout and log in as the regular user. Create repos and use the system!
+
+Note: the admin user cannot create repos.
+
+## Importing data
+
+One way to import data:
+
+1. Create your new repo in gitprep.
+2. In your local git repo, add a new remote target: 
+```
+git remote add gitprep git@my.gitprep.server:new-repo.git 
+```
+3. Push all your repo content up in to this new gitprep target.
+4. Update your local git repo config such that gitprep is now the origin.
+
+Copy from `/var/lib/gitolite` or `/var/lib/gitosis`
+
+TBD
+
+## Internal Server Error
+
+If you receive an internal server error, look at the log file (gitprep/log/production.log)
+to see what problem has occurred.
+
+# FAQ
 
 ### blame don't work
 

...	...	@@ -14,101 +14,6 @@ Github clone. You can install portable github system into Unix/Linux.
14	14	* CGI support, built-in web server, and reverse proxy support.
15	15	* SSL support.
16	16
17		-# Installation into Shared Server
18		-
19		-Shared Server must support Linux/Unix, Apache, SuExec,
20		-CGI, and PHP5(CGI mode).
21		-
22		-(PHP is not strictly necessary. If PHP exists, the install process is easy
23		-because you do not need to think about permissions.)
24		-
25		-Many shared servers support these, so you will be able to find or setup a suitable server easily.
26		-
27		-## Download
28		-
29		-First you need to [download gitprep](https://github.com/yuki-kimoto/gitprep/archive/latest.zip).
30		-
31		-Expand the zip file. You will see the following directory:
32		-
33		- gitprep-latest
34		-
35		-Rename the gitprep-latest directory to gitprep.
36		-
37		- gitprep-latest -> gitprep
38		-
39		-If you know latest gitprep release, I inform you in the following blog
40		-or mailing list.
41		-
42		-[Yuki Kimoto Perl Blog](http://blogs.perl.org/users/yuki_kimoto/)
43		-
44		-[Google GitPrep Group](https://groups.google.com/forum/#!forum/gitprep)
45		-
46		-## Configuration
47		-
48		-GitPrep needs the git command. You must install git by yourself.
49		-If you haven't set user.name and user.email, you must set them.
50		-
51		- git config --global user.name "gitprep"
52		- git config --global user.email "gitprep@example.com"
53		-
54		-You must add the correct git command path to the gitprep.conf config file.
55		-
56		- [basic]
57		- ;;; Git command path
58		- git_bin=/home/yourname/local/bin/git
59		-
60		-## Upload Server by FTP
61		-
62		-You should upload these directories into server document root by FTP.
63		-
64		-## Setup
65		-
66		-Access the following URL by browser:
67		-
68		- http://(Your host name)/gitprep/setup/setup.php
69		-
70		-If you don't access PHP file or don't have PHP,
71		-you can use CGI script. Please set this CGI script permission to `755`.
72		-
73		- http://(Your host name)/gitprep/setup/setup.cgi
74		-
75		-Click the Setup button once and wait about 5 minutes.
76		-
77		-## Go to application
78		-
79		-If you see the result screen, click "Go to Application".
80		-
81		-## Getting started
82		-
83		-On a fresh install, you will be asked to create the admin user.
84		-
85		-Log in as the admin user, then create a new regular user.
86		-
87		-Logout and log in as the regular user. Create repos and use the system!
88		-
89		-Note: the admin user cannot create repos.
90		-
91		-## Importing data
92		-
93		-One way to import data:
94		-
95		-1. Create your new repo in gitprep.
96		-2. In your local git repo, add a new remote target:
97		-```
98		-git remote add gitprep git@my.gitprep.server:new-repo.git
99		-```
100		-3. Push all your repo content up in to this new gitprep target.
101		-4. Update your local git repo config such that gitprep is now the origin.
102		-
103		-Copy from `/var/lib/gitolite` or `/var/lib/gitosis`
104		-
105		-TBD
106		-
107		-## Internal Server Error
108		-
109		-If you receive an internal server error, look at the log file (gitprep/log/production.log)
110		-to see what problem has occurred.
111		-
112	17	# Installation into own Unix/Linux Server
113	18
114	19	GitPrep has its own web server,
...	...	@@ -154,7 +59,17 @@ If "All tests successful" is shown, the setup process was successful.
154	59
155	60	## Configuration
156	61
157		-Same as Shared Server's Configuration section.
	62	+GitPrep needs the git command. You must install git by yourself.
	63	+If you haven't set user.name and user.email, you must set them.
	64	+
	65	+ git config --global user.name "gitprep"
	66	+ git config --global user.email "gitprep@example.com"
	67	+
	68	+You must add the correct git command path to the gitprep.conf config file.
	69	+
	70	+ [basic]
	71	+ ;;; Git command path
	72	+ git_bin=/home/yourname/local/bin/git
158	73
159	74	## Operation
160	75
...	...	@@ -225,7 +140,93 @@ If you have git, it is easy to install from git.
225	140
226	141	It is useful to write configuration in *gitprep.my.conf*, not gitprep.conf.
227	142
228		-## FAQ
	143	+# Installation into Shared Server
	144	+
	145	+Shared Server must support Linux/Unix, Apache, SuExec,
	146	+CGI, and PHP5(CGI mode).
	147	+
	148	+(PHP is not strictly necessary. If PHP exists, the install process is easy
	149	+because you do not need to think about permissions.)
	150	+
	151	+**Note that CGI script only work on shared server which support CGI + SuExec.
	152	+At first, you should check the shared server support CGI + SuExec.**
	153	+
	154	+## Download
	155	+
	156	+First you need to [download gitprep](https://github.com/yuki-kimoto/gitprep/archive/latest.zip).
	157	+
	158	+Expand the zip file. You will see the following directory:
	159	+
	160	+ gitprep-latest
	161	+
	162	+Rename the gitprep-latest directory to gitprep.
	163	+
	164	+ gitprep-latest -> gitprep
	165	+
	166	+If you know latest gitprep release, I inform you in the following blog
	167	+or mailing list.
	168	+
	169	+[Yuki Kimoto Perl Blog](http://blogs.perl.org/users/yuki_kimoto/)
	170	+
	171	+[Google GitPrep Group](https://groups.google.com/forum/#!forum/gitprep)
	172	+
	173	+## Configuration
	174	+
	175	+Same as "Installation into own Unix/Linux Server" Configuration section.
	176	+
	177	+## Upload Server by FTP
	178	+
	179	+You should upload these directories into server document root by FTP.
	180	+
	181	+## Setup
	182	+
	183	+Access the following URL by browser:
	184	+
	185	+ http://(Your host name)/gitprep/setup/setup.php
	186	+
	187	+If you don't access PHP file or don't have PHP,
	188	+you can use CGI script. Please set this CGI script permission to `755`.
	189	+
	190	+ http://(Your host name)/gitprep/setup/setup.cgi
	191	+
	192	+Click the Setup button once and wait about 5 minutes.
	193	+
	194	+## Go to application
	195	+
	196	+If you see the result screen, click "Go to Application".
	197	+
	198	+## Getting started
	199	+
	200	+On a fresh install, you will be asked to create the admin user.
	201	+
	202	+Log in as the admin user, then create a new regular user.
	203	+
	204	+Logout and log in as the regular user. Create repos and use the system!
	205	+
	206	+Note: the admin user cannot create repos.
	207	+
	208	+## Importing data
	209	+
	210	+One way to import data:
	211	+
	212	+1. Create your new repo in gitprep.
	213	+2. In your local git repo, add a new remote target:
	214	+```
	215	+git remote add gitprep git@my.gitprep.server:new-repo.git
	216	+```
	217	+3. Push all your repo content up in to this new gitprep target.
	218	+4. Update your local git repo config such that gitprep is now the origin.
	219	+
	220	+Copy from `/var/lib/gitolite` or `/var/lib/gitosis`
	221	+
	222	+TBD
	223	+
	224	+## Internal Server Error
	225	+
	226	+If you receive an internal server error, look at the log file (gitprep/log/production.log)
	227	+to see what problem has occurred.
	228	+
	229	+# FAQ
229	230
230	231	### blame don't work
231	232