Description:
Update README.rdoc
Commit status:
[Not Reviewed]
References:
Diff options:
Comments:
0 Commit comments
0 Inline Comments
Unresolved TODOs:
There are no unresolved TODOs
Author
Nattee Niparnan
-
r861:b967d2a3a85c - - 1 file changed: 1 inserted, 1 deleted
| @@ -1,160 +1,160 | |||||
|
|
1 | == Installation |
|
1 | == Installation |
|
|
2 |
|
2 | ||
|
|
3 | Installing cafe-grader can be done in the following steps. |
|
3 | Installing cafe-grader can be done in the following steps. |
|
|
4 |
|
4 | ||
|
|
5 | 1. Set up database. We need MySQL 5 database name, username and password. |
|
5 | 1. Set up database. We need MySQL 5 database name, username and password. |
|
|
6 | 2. Install RVM. cafe-grader runs on Ruby on Rails and the best way to install it is to use RVM. |
|
6 | 2. Install RVM. cafe-grader runs on Ruby on Rails and the best way to install it is to use RVM. |
|
|
7 | 3. Install necessary package for the system |
|
7 | 3. Install necessary package for the system |
|
|
8 | 4. Install cafe-grader from github |
|
8 | 4. Install cafe-grader from github |
|
|
9 | 5. Deploy cafe-grader on apache with Phusion Passenger |
|
9 | 5. Deploy cafe-grader on apache with Phusion Passenger |
|
|
10 |
|
10 | ||
|
|
11 | Very important!!! All commands should be run from a normal user. |
|
11 | Very important!!! All commands should be run from a normal user. |
|
|
12 |
|
12 | ||
|
|
13 | The detail of each step are provided as follows. |
|
13 | The detail of each step are provided as follows. |
|
|
14 |
|
14 | ||
|
|
15 | === 1. Install MySQL 5 |
|
15 | === 1. Install MySQL 5 |
|
|
16 |
|
16 | ||
|
|
17 | Install MySQL server for the server. |
|
17 | Install MySQL server for the server. |
|
|
18 |
|
18 | ||
|
|
19 | cafe@grader:~$ sudo apt install mysql-server |
|
19 | cafe@grader:~$ sudo apt install mysql-server |
|
|
20 |
|
20 | ||
|
|
21 | Next, we will connect to mysql as root and set up the database. You can choose your DATABASENAME, USERNAME and PASSWORD as you wish. |
|
21 | Next, we will connect to mysql as root and set up the database. You can choose your DATABASENAME, USERNAME and PASSWORD as you wish. |
|
|
22 |
|
22 | ||
|
|
23 | cafe@grader:~$ sudo mysql -u root |
|
23 | cafe@grader:~$ sudo mysql -u root |
|
|
24 |
|
24 | ||
|
|
25 | mysql> create database DATABASENAME; |
|
25 | mysql> create database DATABASENAME; |
|
|
26 | Query OK, 1 row affected (0.00 sec) |
|
26 | Query OK, 1 row affected (0.00 sec) |
|
|
27 |
|
27 | ||
|
|
28 | mysql> create user USERNAME@localhost identified by 'PASSWORD'; |
|
28 | mysql> create user USERNAME@localhost identified by 'PASSWORD'; |
|
|
29 | Query OK, 0 rows affected, 1 warning (0.00 sec) |
|
29 | Query OK, 0 rows affected, 1 warning (0.00 sec) |
|
|
30 |
|
30 | ||
|
|
31 | mysql> grant all privileges on DATABASENAME.* to USERNAME@localhost; |
|
31 | mysql> grant all privileges on DATABASENAME.* to USERNAME@localhost; |
|
|
32 | Query OK, 0 rows affected, 1 warning (0.00 sec) |
|
32 | Query OK, 0 rows affected, 1 warning (0.00 sec) |
|
|
33 |
|
33 | ||
|
|
34 | mysql> flush privileges; |
|
34 | mysql> flush privileges; |
|
|
35 | Query OK, 0 rows affected (0.00 sec) |
|
35 | Query OK, 0 rows affected (0.00 sec) |
|
|
36 |
|
36 | ||
|
|
37 | === 2. Install RVM |
|
37 | === 2. Install RVM |
|
|
38 |
|
38 | ||
|
|
39 | Since Ubuntu has dedicated package for RVM we will use that. Just follow instruction given in https://github.com/rvm/ubuntu_rvm. For your convenience, the step are reproduced here. |
|
39 | Since Ubuntu has dedicated package for RVM we will use that. Just follow instruction given in https://github.com/rvm/ubuntu_rvm. For your convenience, the step are reproduced here. |
|
|
40 |
|
40 | ||
|
|
41 | First, we install necessary package for installing RVM. |
|
41 | First, we install necessary package for installing RVM. |
|
|
42 |
|
42 | ||
|
|
43 | cafe@grader:~$ sudo apt install software-properties-common |
|
43 | cafe@grader:~$ sudo apt install software-properties-common |
|
|
44 |
|
44 | ||
|
|
45 | Second, we add the custom PPA, update the system and install RVM. |
|
45 | Second, we add the custom PPA, update the system and install RVM. |
|
|
46 |
|
46 | ||
|
|
47 | cafe@grader:~$ sudo apt-add-repository -y ppa:rael-gc/rvm |
|
47 | cafe@grader:~$ sudo apt-add-repository -y ppa:rael-gc/rvm |
|
|
48 | cafe@grader:~$ sudo apt-get update |
|
48 | cafe@grader:~$ sudo apt-get update |
|
|
49 | cafe@grader:~$ sudo apt-get install rvm |
|
49 | cafe@grader:~$ sudo apt-get install rvm |
|
|
50 |
|
50 | ||
|
|
51 | We also need to add our user to the rvm group |
|
51 | We also need to add our user to the rvm group |
|
|
52 |
|
52 | ||
|
|
53 | sudo usermod -a -G rvm $USER |
|
53 | sudo usermod -a -G rvm $USER |
|
|
54 |
|
54 | ||
|
|
55 | This is very important. |
|
55 | This is very important. |
|
|
56 | 1. You have to reboot since RVM change a lots of system. |
|
56 | 1. You have to reboot since RVM change a lots of system. |
|
|
57 | 2. If you are using GUI version of Ubuntu, be sure to have Gnome Terminal (or any other terminal you are using) perform login every time. This can be done by mark the check box "Run command as a login shell" in Gnome terminal or by adding --login to bash. |
|
57 | 2. If you are using GUI version of Ubuntu, be sure to have Gnome Terminal (or any other terminal you are using) perform login every time. This can be done by mark the check box "Run command as a login shell" in Gnome terminal or by adding --login to bash. |
|
|
58 |
|
58 | ||
|
|
59 | === 3. Install necessary package and nodejs |
|
59 | === 3. Install necessary package and nodejs |
|
|
60 |
|
60 | ||
|
|
61 |
|
61 | ||
|
|
62 | First, we install required package via apt. |
|
62 | First, we install required package via apt. |
|
|
63 |
|
63 | ||
|
|
64 |
- cafe@grader:~$ sudo apt install git libmysqlclient-dev default-jdk unzip php-cli apache2 |
|
64 | + cafe@grader:~$ sudo apt install git libmysqlclient-dev default-jdk unzip php-cli apache2 apache2-dev |
|
|
65 |
|
65 | ||
|
|
66 | Next, we need nodejs. Depends on your ubuntu version, the step to install correct version of nodejs differs. |
|
66 | Next, we need nodejs. Depends on your ubuntu version, the step to install correct version of nodejs differs. |
|
|
67 |
|
67 | ||
|
|
68 | ==== 3.1 Install nodejs on Ubuntu 18.04 |
|
68 | ==== 3.1 Install nodejs on Ubuntu 18.04 |
|
|
69 |
|
69 | ||
|
|
70 | Since nodejs that comes with ubuntu 18.04 is very outdated, we need to install it manually. This follow the method outlined in https://www.digitalocean.com/community/tutorials/how-to-install-node-js-on-ubuntu-18-04 under *Installing Node.js with Apt Using a NodeSource PPA* |
|
70 | Since nodejs that comes with ubuntu 18.04 is very outdated, we need to install it manually. This follow the method outlined in https://www.digitalocean.com/community/tutorials/how-to-install-node-js-on-ubuntu-18-04 under *Installing Node.js with Apt Using a NodeSource PPA* |
|
|
71 |
|
71 | ||
|
|
72 | cd ~ |
|
72 | cd ~ |
|
|
73 | curl -sL https://deb.nodesource.com/setup_17.x -o nodesource_setup.sh |
|
73 | curl -sL https://deb.nodesource.com/setup_17.x -o nodesource_setup.sh |
|
|
74 | sudo bash nodesource_setup.sh |
|
74 | sudo bash nodesource_setup.sh |
|
|
75 | sudo apt install nodejs |
|
75 | sudo apt install nodejs |
|
|
76 |
|
76 | ||
|
|
77 | ==== 3.2 Install nodejs on Ubuntu 20.04 or newer |
|
77 | ==== 3.2 Install nodejs on Ubuntu 20.04 or newer |
|
|
78 |
|
78 | ||
|
|
79 | cafe@grader:~$ sudo apt install nodejs |
|
79 | cafe@grader:~$ sudo apt install nodejs |
|
|
80 |
|
80 | ||
|
|
81 | === 4. Install cafe-grader |
|
81 | === 4. Install cafe-grader |
|
|
82 |
|
82 | ||
|
|
83 | First, ensure that RVM is installed correctly. |
|
83 | First, ensure that RVM is installed correctly. |
|
|
84 |
|
84 | ||
|
|
85 | cafe@grader:~$ rvm |
|
85 | cafe@grader:~$ rvm |
|
|
86 |
|
86 | ||
|
|
87 | If you get a result similar to this. |
|
87 | If you get a result similar to this. |
|
|
88 |
|
88 | ||
|
|
89 | Command 'rvm' not found, but there are 21 similar ones. |
|
89 | Command 'rvm' not found, but there are 21 similar ones. |
|
|
90 |
|
90 | ||
|
|
91 | It is very likely that you have not re-login or you are using bash without --login. Please do so and re-read the installation of RVM on Ubuntu https://github.com/rvm/ubuntu_rvm again. |
|
91 | It is very likely that you have not re-login or you are using bash without --login. Please do so and re-read the installation of RVM on Ubuntu https://github.com/rvm/ubuntu_rvm again. |
|
|
92 |
|
92 | ||
|
|
93 | Next, we will let the install script do the work of installing cafe-grader. Please prepare the DATABASENAME, USERNAME and PASSWORD as the script will ask for that. Make sure that you run the script from the home directory of the user. |
|
93 | Next, we will let the install script do the work of installing cafe-grader. Please prepare the DATABASENAME, USERNAME and PASSWORD as the script will ask for that. Make sure that you run the script from the home directory of the user. |
|
|
94 |
|
94 | ||
|
|
95 | cafe@grader:~$ wget https://github.com/cafe-grader-team/cafe-grader-judge-scripts/raw/master/installer/install.sh |
|
95 | cafe@grader:~$ wget https://github.com/cafe-grader-team/cafe-grader-judge-scripts/raw/master/installer/install.sh |
|
|
96 | cafe@grader:~$ . ./install.sh |
|
96 | cafe@grader:~$ . ./install.sh |
|
|
97 |
|
97 | ||
|
|
98 | After installation is finished, grader is ready to run in development mode via Puma. We will try that by the following command which will start a grader accessible via http://localhost:3000/. You can try logging in to the system and verify that it is actually work. |
|
98 | After installation is finished, grader is ready to run in development mode via Puma. We will try that by the following command which will start a grader accessible via http://localhost:3000/. You can try logging in to the system and verify that it is actually work. |
|
|
99 |
|
99 | ||
|
|
100 | cafe@grader:~/cafe_grader/web$ rails s |
|
100 | cafe@grader:~/cafe_grader/web$ rails s |
|
|
101 |
|
101 | ||
|
|
102 | If Everything is OK, stop the Puma by Ctrl-C. |
|
102 | If Everything is OK, stop the Puma by Ctrl-C. |
|
|
103 |
|
103 | ||
|
|
104 | We are almost done. The last step is to set up apache and Phusion so that cafe-grader is served by apache. |
|
104 | We are almost done. The last step is to set up apache and Phusion so that cafe-grader is served by apache. |
|
|
105 |
|
105 | ||
|
|
106 | === 5. Deploy cafe-grader on Phusion passenger via apache |
|
106 | === 5. Deploy cafe-grader on Phusion passenger via apache |
|
|
107 |
|
107 | ||
|
|
108 | This will install a Passenger mod for apache. You can start by visiting https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver/apache/oss/install_passenger_main.html and fllow through the guide. We have reproduce the step here for Ubuntu 18.04. For other version, please select the appropriate one on the previous link. |
|
108 | This will install a Passenger mod for apache. You can start by visiting https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver/apache/oss/install_passenger_main.html and fllow through the guide. We have reproduce the step here for Ubuntu 18.04. For other version, please select the appropriate one on the previous link. |
|
|
109 |
|
109 | ||
|
|
110 | The deploy is divided into two parts: Installing Passenger and deploying the app. |
|
110 | The deploy is divided into two parts: Installing Passenger and deploying the app. |
|
|
111 |
|
111 | ||
|
|
112 | ==== 5.1. Installing Passenger as a mod for apache via PPA and enable it. |
|
112 | ==== 5.1. Installing Passenger as a mod for apache via PPA and enable it. |
|
|
113 |
|
113 | ||
|
|
114 | cafe@grader:~$ sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 561F9B9CAC40B2F7 |
|
114 | cafe@grader:~$ sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 561F9B9CAC40B2F7 |
|
|
115 | cafe@grader:~$ sudo apt-get install -y apt-transport-https ca-certificates |
|
115 | cafe@grader:~$ sudo apt-get install -y apt-transport-https ca-certificates |
|
|
116 | cafe@grader:~$ sudo sh -c 'echo deb https://oss-binaries.phusionpassenger.com/apt/passenger bionic main > /etc/apt/sources.list.d/passenger.list' |
|
116 | cafe@grader:~$ sudo sh -c 'echo deb https://oss-binaries.phusionpassenger.com/apt/passenger bionic main > /etc/apt/sources.list.d/passenger.list' |
|
|
117 | cafe@grader:~$ sudo apt-get update |
|
117 | cafe@grader:~$ sudo apt-get update |
|
|
118 | cafe@grader:~$ sudo apt-get install -y libapache2-mod-passenger |
|
118 | cafe@grader:~$ sudo apt-get install -y libapache2-mod-passenger |
|
|
119 | cafe@grader:~$ sudo a2enmod passenger |
|
119 | cafe@grader:~$ sudo a2enmod passenger |
|
|
120 |
|
120 | ||
|
|
121 |
|
121 | ||
|
|
122 | cafe@grader:~$ sudo apache2ctl restart |
|
122 | cafe@grader:~$ sudo apache2ctl restart |
|
|
123 |
|
123 | ||
|
|
124 | Finally, we should check that passenger is installed correctly. Run the following command and fix anything as suggested by the command. |
|
124 | Finally, we should check that passenger is installed correctly. Run the following command and fix anything as suggested by the command. |
|
|
125 |
|
125 | ||
|
|
126 | cafe@grader:~$ sudo /usr/bin/passenger-config validate-install |
|
126 | cafe@grader:~$ sudo /usr/bin/passenger-config validate-install |
|
|
127 |
|
127 | ||
|
|
128 | ==== 5.2. Deploying the app. First, we determine the exact location of our ruby that is installed via RVM. |
|
128 | ==== 5.2. Deploying the app. First, we determine the exact location of our ruby that is installed via RVM. |
|
|
129 |
|
129 | ||
|
|
130 | cafe@grader:~$ passenger-config about ruby-command |
|
130 | cafe@grader:~$ passenger-config about ruby-command |
|
|
131 | passenger-config was invoked through the following Ruby interpreter: |
|
131 | passenger-config was invoked through the following Ruby interpreter: |
|
|
132 | Command: /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby |
|
132 | Command: /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby |
|
|
133 | Version: ruby 2.3.7p456 (2018-03-28 revision 63024) [x86_64-linux] |
|
133 | Version: ruby 2.3.7p456 (2018-03-28 revision 63024) [x86_64-linux] |
|
|
134 | To use in Apache: PassengerRuby /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby |
|
134 | To use in Apache: PassengerRuby /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby |
|
|
135 | To use in Nginx : passenger_ruby /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby |
|
135 | To use in Nginx : passenger_ruby /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby |
|
|
136 | To use with Standalone: /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby /usr/bin/passenger start |
|
136 | To use with Standalone: /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby /usr/bin/passenger start |
|
|
137 |
|
137 | ||
|
|
138 | Then, take note of the path after "Command". For this guide, it is /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby |
|
138 | Then, take note of the path after "Command". For this guide, it is /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby |
|
|
139 |
|
139 | ||
|
|
140 | Assuming that cafe-grader is installed at /home/cafe/cafe_grader, we will edit the Apache's site config file /etc/apache2/site-enabled/000-default.conf as follow. |
|
140 | Assuming that cafe-grader is installed at /home/cafe/cafe_grader, we will edit the Apache's site config file /etc/apache2/site-enabled/000-default.conf as follow. |
|
|
141 |
|
141 | ||
|
|
142 | <VirtualHost *:80> |
|
142 | <VirtualHost *:80> |
|
|
143 | #ServerName www.example.com |
|
143 | #ServerName www.example.com |
|
|
144 |
|
144 | ||
|
|
145 | ServerAdmin webmaster@localhost |
|
145 | ServerAdmin webmaster@localhost |
|
|
146 | # dont forget to change the document root |
|
146 | # dont forget to change the document root |
|
|
147 | DocumentRoot /home/cafe/cafe_grader/web/public |
|
147 | DocumentRoot /home/cafe/cafe_grader/web/public |
|
|
148 |
|
148 | ||
|
|
149 | ErrorLog ${APACHE_LOG_DIR}/error.log |
|
149 | ErrorLog ${APACHE_LOG_DIR}/error.log |
|
|
150 | CustomLog ${APACHE_LOG_DIR}/access.log combined |
|
150 | CustomLog ${APACHE_LOG_DIR}/access.log combined |
|
|
151 |
|
151 | ||
|
|
152 | # add Passenger |
|
152 | # add Passenger |
|
|
153 | PassengerRuby /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby |
|
153 | PassengerRuby /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby |
|
|
154 |
|
154 | ||
|
|
155 | # our cafe-grader app |
|
155 | # our cafe-grader app |
|
|
156 | <Directory /home/cafe/cafe_grader/web/public> |
|
156 | <Directory /home/cafe/cafe_grader/web/public> |
|
|
157 | Allow from all |
|
157 | Allow from all |
|
|
158 | Options -MultiViews |
|
158 | Options -MultiViews |
|
|
159 | Require all granted |
|
159 | Require all granted |
|
|
160 | </Directory> |
|
160 | </Directory> |
You need to be logged in to leave comments.
Login now