improved README
|
1 |
# GitPrep |
2 | ||
Update README.md
|
3 |
Github clone. You can install portable github system into Unix/Linux. |
improved README
|
4 | |
added image
|
5 |
<img src="http://cdn-ak.f.st-hatena.com/images/fotolife/p/perlcodesample/20130421/20130421180903_original.png" width="850"> |
6 | ||
improved README
|
7 |
# Features |
8 | ||
9 |
* Github clone |
|
Update README.md
|
10 |
* Portable. You can install it into your Unix/Linux server. |
11 |
* Only needs Perl 5.8.7+ |
|
improved install process
|
12 |
* CGI support |
Fix typos in README
|
13 |
* Having built-in web server, Reverse proxy support |
improve readme
|
14 |
* SSL support |
15 |
* IP control suppport |
|
improved README
|
16 | |
improved install process
|
17 |
# Installation into Shared Server |
fixed git_bin not found bug
|
18 | |
improved install process
|
19 |
Shared Server must support **Linux/Unix**, **Apache**, **SuExec**, |
20 |
**CGI**, and **PHP5(CGI mode)**. |
|
fixed git_bin not found bug
|
21 | |
Update README.md
|
22 |
(PHP is not necessary, if PHP exists, the install process is easy |
23 |
because you do not need to think about permissions.) |
|
fixed git_bin not found bug
|
24 | |
Update README.md
|
25 |
Many shared servers support these, |
26 |
so you will be able to find a suitable server easily. |
|
fixed git_bin not found bug
|
27 | |
28 |
## Download |
|
29 | ||
Update README.md
|
30 |
First you need to download gitprep. |
fixed git_bin not found bug
|
31 | |
fixed database file permissi...
|
32 |
https://github.com/yuki-kimoto/gitprep/archive/latest.zip |
fixed git_bin not found bug
|
33 | |
Update README.md
|
34 |
Expand the zip file. You will see the following directory. |
fixed git_bin not found bug
|
35 | |
fixed database file permissi...
|
36 |
gitprep-latest |
fixed git_bin not found bug
|
37 | |
Update README.md
|
38 |
Rename the gitprep-latest directory to gitprep. |
fixed git_bin not found bug
|
39 | |
fixed database file permissi...
|
40 |
gitprep-latest -> gitprep |
fixed git_bin not found bug
|
41 | |
improved install process
|
42 |
## Configuration |
fixed git_bin not found bug
|
43 | |
Update README.md
|
44 |
GitPrep needs the git command. You must install git by yourself. |
fixed git_bin not found bug
|
45 | |
Update README.md
|
46 |
You must add the correct git command path to the **gitprep.conf** config file. |
fixed git_bin not found bug
|
47 | |
48 |
[basic] |
|
49 |
;;; Git command path |
|
fix mini bug
|
50 |
git_bin=/home/yourname/local/bin/git |
fixed git_bin not found bug
|
51 | |
52 |
## Upload Server by FTP |
|
53 | ||
54 |
You upload these directory into server document root by FTP. |
|
55 | ||
56 |
## Setup |
|
57 | ||
58 |
Access the following URL by browser. |
|
59 | ||
fixed readme
|
60 |
http://(Your host name)/gitprep/setup/setup.php |
fixed git_bin not found bug
|
61 | |
improved install process
|
62 |
(If you don't access PHP file or don't have PHP, |
63 |
you can use CGI script |
|
64 |
please set this CGI script permission to 755) |
|
65 | ||
66 |
http://(Your host name)/gitprep/setup/setup.cgi. |
|
67 | ||
Fix typos in README
|
68 |
Click Setup button once and wait about 5 minutes. |
fixed git_bin not found bug
|
69 | |
70 |
## Go to application |
|
71 | ||
72 |
If you see result, click "Go to Application". |
|
73 | ||
Update README.md
|
74 |
## Internal Server Error |
fixed git_bin not found bug
|
75 | |
Update README.md
|
76 |
If you receive an internal server error, look at the log file (gitprep/log/production.log) |
77 |
to see what the problem occurred. |
|
fixed git_bin not found bug
|
78 | |
Fix typos in README
|
79 |
# Installation into own Unix/Linux Server |
improved install process
|
80 | |
Update README.md
|
81 |
GitPrep has its own web server, |
82 |
so you can start using the application very easily. |
|
83 |
This is much better than the way shown above |
|
84 |
because you do not need to setup the Apache environment |
|
85 |
and performance will be much better. |
|
improved README
|
86 | |
added cygwin case
|
87 |
(You can also install GitPrep into Cygwin. |
88 |
If you want to install GitPrep into Cygwin, |
|
89 |
gcc4 and make program are needed.) |
|
90 | ||
improved README
|
91 |
## Create gitprep user |
92 | ||
Update README.md
|
93 |
Create a **gitprep** user. This is not necessary, but recommended. |
improved README
|
94 | |
improved README
|
95 |
useradd gitprep |
96 |
su - gitprep |
|
97 |
cd ~ |
|
98 | ||
improved README
|
99 |
## Download |
improved README
|
100 | |
Update README.md
|
101 |
Download tar.gz archive, expand it and change directory. |
removed Mojoliciosu dependen...
|
102 | |
fixed database file permissi...
|
103 |
curl -kL https://github.com/yuki-kimoto/gitprep/archive/latest.tar.gz > gitprep-latest.tar.gz |
104 |
tar xf gitprep-latest.tar.gz |
|
105 |
mv gitprep-latest gitprep |
|
improved install process
|
106 |
cd gitprep |
improved README
|
107 | |
108 |
## Setup |
|
109 | ||
Update README.md
|
110 |
To setup GitPrep, execute the following command. All of the needed modules will be installed. |
improved README
|
111 | |
improved install process
|
112 |
./setup.sh |
113 | ||
114 |
## Test |
|
115 | ||
Update README.md
|
116 |
Run the test to check if the setup process was successful or not. |
improved install process
|
117 | |
118 |
prove t |
|
119 | ||
Update README.md
|
120 |
If "All tests successful" is shown, the setup process was successful. |
improved install process
|
121 | |
122 |
## Configuration |
|
123 | ||
124 |
Same as Shared Server's Configuration section. |
|
improved README
|
125 | |
126 |
## Operation |
|
127 | ||
128 |
### Start |
|
129 | ||
Update README.md
|
130 |
You can start the application by running the provided gitprep script. |
131 |
The application is run in the background and the port is **10020** by default. |
|
improved README
|
132 | |
133 |
./gitprep |
|
134 | ||
Update README.md
|
135 |
Then access the following URL. |
Fix typos in README
|
136 | |
improved README
|
137 |
http://localhost:10020 |
Fix typos in README
|
138 | |
Update README.md
|
139 |
If you want to change the port, edit gitprep.conf. |
140 |
If you cannot access this port, you might change the firewall settings. |
|
improved README
|
141 | |
142 |
### Stop |
|
143 | ||
Update README.md
|
144 |
You can stop the application by adding the **--stop** option. |
improved README
|
145 | |
146 |
./gitprep --stop |
|
147 | ||
improve readme
|
148 |
### Operation from root user |
improved README
|
149 | |
Update README.md
|
150 |
You can manage the application from the root user. |
improved README
|
151 | |
Update README.md
|
152 |
Start the application |
improved install process
|
153 | |
fix readme
|
154 |
sudo -u gitprep /home/gitprep/gitprep/gitprep |
improved install process
|
155 | |
Update README.md
|
156 |
Stop the application |
improved install process
|
157 | |
fix readme
|
158 |
sudo -u gitprep /home/gitprep/gitprep/gitprep --stop |
improved install process
|
159 | |
Update README.md
|
160 |
If you want to start the application when the OS starts, |
improve readme
|
161 |
add the start application command to **rc.local**(Linux). |
improved install process
|
162 | |
Update README.md
|
163 |
If you want to make it easy to manage gitprep, |
164 |
then create a run script. |
|
Fix typos in README
|
165 | |
improved README
|
166 |
mkdir -p /webapp |
fix readme
|
167 |
echo '#!/bin/sh' > /webapp/gitprep |
cleanup and improve readme, ...
|
168 |
echo 'su - gitprep -c "/home/gitprep/gitprep/gitprep $*"' >> /webapp/gitprep |
fix readme
|
169 |
chmod 755 /webapp/gitprep |
improved install process
|
170 | |
Update README.md
|
171 |
You can start and stop the application with the following command. |
Fix typos in README
|
172 | |
improved README
|
173 |
# Start or Restart |
174 |
/webapp/gitprep |
|
Fix typos in README
|
175 | |
improved install process
|
176 |
# Stop |
improved README
|
177 |
/webapp/gitprep --stop |
Fix typos in README
|
178 | |
improved install process
|
179 |
## Developer |
improved README
|
180 | |
Update README.md
|
181 |
If you are a developer, you can start the application in development mode. |
improved README
|
182 | |
fixed readme
|
183 |
./morbo |
improved README
|
184 | |
Update README.md
|
185 |
Then access the following URL. |
Fix typos in README
|
186 | |
improved README
|
187 |
http://localhost:3000 |
improved install process
|
188 | |
189 |
If you have git, it is easy to install from git. |
|
190 | ||
191 |
git clone git://github.com/yuki-kimoto/gitprep.git |
|
192 | ||
Fix typos in README
|
193 |
It is useful to write configuration in ***gitprep.my.conf***, not gitprep.conf. |
improved install process
|
194 | |
add web site link
|
195 |
## Web Site |
196 | ||
197 |
[GitPrep Web Site](http://perlcodesample.sakura.ne.jp/gitprep-site/) |
|
198 | ||
fix pod
|
199 |
## Internally Using Library |
add internally using project
|
200 | |
201 |
* [Config::Tiny](http://search.cpan.org/dist/Config-Tiny/lib/Config/Tiny.pm) |
|
202 |
* [DBD::SQLite](http://search.cpan.org/dist/DBD-SQLite/lib/DBD/SQLite.pm) |
|
203 |
* [DBI](http://search.cpan.org/dist/DBI/DBI.pm) |
|
204 |
* [DBIx::Connector](http://search.cpan.org/dist/DBIx-Connector/lib/DBIx/Connector.pm) |
|
205 |
* [DBIx::Custom](http://search.cpan.org/dist/DBIx-Custom/lib/DBIx/Custom.pm) |
|
206 |
* [Mojolicious](http://search.cpan.org/~kimoto/DBIx-Custom/lib/DBIx/Custom.pm) |
|
207 |
* [Mojolicious::Plugin::INIConfig](http://search.cpan.org/dist/Mojolicious-Plugin-INIConfig/lib/Mojolicious/Plugin/INIConfig.pm) |
|
208 |
* [mojo-legacy](https://github.com/jamadam/mojo-legacy) |
|
209 |
* [Object::Simple](http://search.cpan.org/dist/Object-Simple/lib/Object/Simple.pm) |
|
210 |
* [Validator::Custom](http://search.cpan.org/dist/Validator-Custom/lib/Validator/Custom.pm) |
|
211 | ||
add WebDBViewer link
|
212 |
## Sister project |
213 | ||
214 |
* [WebDBViewer](https://github.com/yuki-kimoto/webdbviewer) - Database viewer to see database information on web browser. |
|
215 | ||
improved install process
|
216 |
## Copyright & license |
217 | ||
218 |
Copyright 2013-2013 Yuki Kimoto all rights reserved. |
|
219 | ||
220 |
This program is free software; you can redistribute it and/or modify it |
|
221 |
under the same terms as Perl itself. |