cafe-grader-web

Commit r860:ccb0988a4eaf public

parent | child
Description:
Update README.rdoc
Commit status:
[Not Reviewed]
References:
default
Diff options:
Raw Diff | Patch Diff | Download Diff | Show whitespace | Increase context
Comments:
0 Commit comments 0 Inline Comments
Unresolved TODOs:
There are no unresolved TODOs
Side by Side Unified
Expand All Files Collapse All Files Wide Mode Diff
Add another comment
Browse Files

r860:ccb0988a4eaf - - 1 file changed: 15 inserted, 4 deleted

Show file before | Show file after | Raw diff | Download diff | Show whitespace Increase context Show commentsHide comments
@@ -1,139 +1,150
1 1 == Installation
2 2
3 3 Installing cafe-grader can be done in the following steps.
4 4
5 5 1. Set up database. We need MySQL 5 database name, username and password.
6 6 2. Install RVM. cafe-grader runs on Ruby on Rails and the best way to install it is to use RVM.
7 7 3. Install necessary package for the system
8 8 4. Install cafe-grader from github
9 9 5. Deploy cafe-grader on apache with Phusion Passenger
10 10
11 11 Very important!!! All commands should be run from a normal user.
12 12
13 13 The detail of each step are provided as follows.
14 14
15 15 === 1. Install MySQL 5
16 16
17 17 Install MySQL server for the server.
18 18
19 19 cafe@grader:~$ sudo apt install mysql-server
20 20
21 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 23 cafe@grader:~$ sudo mysql -u root
24 24
25 25 mysql> create database DATABASENAME;
26 26 Query OK, 1 row affected (0.00 sec)
27 27
28 - mysql> grant all privileges on DATABASENAME.* to 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)
30 +
31 + mysql> grant all privileges on DATABASENAME.* to USERNAME@localhost;
29 32 Query OK, 0 rows affected, 1 warning (0.00 sec)
30 33
31 34 mysql> flush privileges;
32 35 Query OK, 0 rows affected (0.00 sec)
33 36
34 37 === 2. Install RVM
35 38
36 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.
37 40
38 41 First, we install necessary package for installing RVM.
39 42
40 43 cafe@grader:~$ sudo apt install software-properties-common
41 44
42 45 Second, we add the custom PPA, update the system and install RVM.
43 46
44 47 cafe@grader:~$ sudo apt-add-repository -y ppa:rael-gc/rvm
45 48 cafe@grader:~$ sudo apt-get update
46 49 cafe@grader:~$ sudo apt-get install rvm
47 50
48 51 We also need to add our user to the rvm group
49 52
50 53 sudo usermod -a -G rvm $USER
51 54
52 55 This is very important.
53 56 1. You have to reboot since RVM change a lots of system.
54 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.
55 58
56 59 === 3. Install necessary package and nodejs
57 60
61 +
58 62 First, we install required package via apt.
59 63
60 - cafe@grader:~$ sudo apt install libmysqlclient-dev default-jdk unzip php-cli apache2 dirmngr gnupg apache2-dev
64 + cafe@grader:~$ sudo apt install git libmysqlclient-dev default-jdk unzip php-cli apache2 dirmngr gnupg apache2-dev
65 +
66 + Next, we need nodejs. Depends on your ubuntu version, the step to install correct version of nodejs differs.
67 +
68 + ==== 3.1 Install nodejs on Ubuntu 18.04
61 69
62 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*
63 71
64 72 cd ~
65 73 curl -sL https://deb.nodesource.com/setup_17.x -o nodesource_setup.sh
66 74 sudo bash nodesource_setup.sh
67 75 sudo apt install nodejs
68 76
77 + ==== 3.2 Install nodejs on Ubuntu 20.04 or newer
78 +
79 + cafe@grader:~$ sudo apt install nodejs
69 80
70 81 === 4. Install cafe-grader
71 82
72 83 First, ensure that RVM is installed correctly.
73 84
74 85 cafe@grader:~$ rvm
75 86
76 87 If you get a result similar to this.
77 88
78 89 Command 'rvm' not found, but there are 21 similar ones.
79 90
80 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.
81 92
82 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.
83 94
84 95 cafe@grader:~$ wget https://github.com/cafe-grader-team/cafe-grader-judge-scripts/raw/master/installer/install.sh
85 96 cafe@grader:~$ . ./install.sh
86 97
87 - After installation is finished, grader is ready to run in development mode via WEBrick. 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.
88 99
89 100 cafe@grader:~/cafe_grader/web$ rails s
90 101
91 - If Everything is OK, stop the WEBrick by Ctrl-C.
102 + If Everything is OK, stop the Puma by Ctrl-C.
92 103
93 104 We are almost done. The last step is to set up apache and Phusion so that cafe-grader is served by apache.
94 105
95 106 === 5. Deploy cafe-grader on Phusion passenger via apache
96 107
97 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.
98 109
99 110 The deploy is divided into two parts: Installing Passenger and deploying the app.
100 111
101 112 ==== 5.1. Installing Passenger as a mod for apache via PPA and enable it.
102 113
103 114 cafe@grader:~$ sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 561F9B9CAC40B2F7
104 115 cafe@grader:~$ sudo apt-get install -y apt-transport-https ca-certificates
105 116 cafe@grader:~$ sudo sh -c 'echo deb https://oss-binaries.phusionpassenger.com/apt/passenger bionic main > /etc/apt/sources.list.d/passenger.list'
106 117 cafe@grader:~$ sudo apt-get update
107 118 cafe@grader:~$ sudo apt-get install -y libapache2-mod-passenger
108 119 cafe@grader:~$ sudo a2enmod passenger
109 120
110 121
111 122 cafe@grader:~$ sudo apache2ctl restart
112 123
113 124 Finally, we should check that passenger is installed correctly. Run the following command and fix anything as suggested by the command.
114 125
115 126 cafe@grader:~$ sudo /usr/bin/passenger-config validate-install
116 127
117 128 ==== 5.2. Deploying the app. First, we determine the exact location of our ruby that is installed via RVM.
118 129
119 130 cafe@grader:~$ passenger-config about ruby-command
120 131 passenger-config was invoked through the following Ruby interpreter:
121 132 Command: /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby
122 133 Version: ruby 2.3.7p456 (2018-03-28 revision 63024) [x86_64-linux]
123 134 To use in Apache: PassengerRuby /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby
124 135 To use in Nginx : passenger_ruby /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby
125 136 To use with Standalone: /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby /usr/bin/passenger start
126 137
127 138 Then, take note of the path after "Command". For this guide, it is /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby
128 139
129 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.
130 141
131 142 <VirtualHost *:80>
132 143 #ServerName www.example.com
133 144
134 145 ServerAdmin webmaster@localhost
135 146 # dont forget to change the document root
136 147 DocumentRoot /home/cafe/cafe_grader/web/public
137 148
138 149 ErrorLog ${APACHE_LOG_DIR}/error.log
139 150 CustomLog ${APACHE_LOG_DIR}/access.log combined
You need to be logged in to leave comments. Login now