软件分享 - 开发笔记分享

最后修改人	果农
最后修改时间	2023-02-10 17:56:03
创建人	果农
创建时间	2023-02-10 15:13:58

该文档由果农创建于 2023-02-10 15:13:58 ，果农在 2023-02-10 17:56:03 修改了该文档。

[TOCM]

# canvas-lms系统介绍

canvas-lms是一个开源在线学习管理系统，基于ruby on rails和node js开发，生产版本采用postgresql数据库系统，利用redis进行缓存。

canvas-lms开源项目地址：[](https://github.com/instructure/canvas-lms)[https://github.com/instructure/canvas-lms](https://github.com/instructure/canvas-lms)

canvas-lms开源项目中有关生产环境模式部署下的wiki:[](https://github.com/instructure/canvas-lms/wiki/Production-Start)[https://github.com/instructure/canvas-lms/wiki/Production-Start](https://github.com/instructure/canvas-lms/wiki/Production-Start)

Canvas-lms的中文指南：[](https://zh.guides.instructure.com/)[https://zh.guides.instructure.com/](https://zh.guides.instructure.com/)

# canvas-lms系统部署环境要求

根据wiki上介绍，建议使用Ubuntu 14.04 LTS，16.04 LTS,18.04 LTS或Mac OS，本文章基于Ubuntu server 16.04.7 LTS环境下编写。

另外，wiki上也声明了，canvas-lms对内存的需求较高，建议服务器至少具有8GB RAM，尤其是如果所有内容和服务都在同一台服务器上运行时。

# 数据库的安装和配置

canvas-lms系统使用的Rails库中支持许多类型的数据库，不过官方建议使用postgresql，于是我们先安装postgre数据库,建议使用postgresql版本号高于9.5。  
在Ubuntu 16.04LTS版本下，可以直接按下列方式安装

```
sudo apt-get install postgresql-9.5
```

如果准备将数据库服务器独立出来，那么需要在另外一台服务器上配置postgresql.conf 和 pg_hba.conf文件以保证使用canvas-lms的服务器能够远程连接该数据库服务器。

安装或者连接完成之后，我们需要创建数据库用户和数据库来存放数据，于是我们执行下列语句

```
sudo -u postgres createuser canvas --no-createdb --no-superuser --no-createrole --pwprompt
sudo -u postgres createdb canvas_production --owner=canvas
```

来分别创建一个数据库用户canvas和数据库canvas_production，创建完成之后，我们可以对当前用户进行授权，能够让当前用户进行数据库的管理。

```
sudo -u postgres createuser $USER
sudo -u postgres psql -c "alter user $USER with superuser" postgres
```

如果出现了
```
ALTER ROLE
```
说明已经获得权限，可以直接执行`psql`来进行postgre数据库管理。

# 获取源码

可以通过使用git或者直接下载zip包来进行下载

## 使用git下载

首先记得安装git软件

```
sudo apt-get install git git-core
```
好了，那么我们在去Github上获取源码了，获取后打开并切换到较为稳定的stable分支：

```
git clone https://github.com/instructure/canvas-lms.git canvas
cd canvas
git checkout stable
```

使用git获取的话主要便于之后的系统更新。

## 使用zip压缩包

官方直接提供的是[](https://github.com/instructure/canvas-lms/archive/stable.zip)[https://github.com/instructure/canvas-lms/archive/stable.zip ](https://github.com/instructure/canvas-lms/archive/stable.zip)。  
下载完成之后就可以进行解压操作，注意采用这种方法之后也得记得安装git(`sudo apt install git git-core`)

```
unzip stable.zip
```

# 代码安装

根据官方要求，建议安装在`\var\canvas`目录之下，于是我们先新建一个文件夹，并对当前用户赋予该文件夹的权限，之后将刚刚下载的文件复制到`\var\canvas`目录之下。

```
sudo mkdir -p /var/canvas
sudo chown -R $USER:$GROUP /var/canvas
cd canvas
cp -av . /var/canvas
cd /var/canvas
```

如果采用压缩包安装的话，建议先更名为canvas，然后再直接复制到`/var/canvas`目录之下。

```
mv canvas-lms-stable canvas
sudo mv ./canvas /var
cd /var/canvas
```

# 软件依赖安装

canvas-lms的软件依赖安装主要包括ruby，node.js软件，其中ruby中也包括bundle，node.js中采用yarn来进行依赖安装。

注意：Canvas now requires Ruby 2.6, as of the 2020-10-07 release. Ruby 2.7+ support is untested.  
即对于2020-10-07之后的Canvas-lms系统仅支持使用ruby2.6版本，使用低于2.6版本的无法安装，会提示版本过低，而官方对2.7+版本没有测试，故建议仅安装ruby2.6版本，防止出现异常的错误。

## ruby的安装

而如果我们仅仅是直接使用`sudo apt install ruby`,默认源的安装的版本为ruby2.3，故我们需要先添加源之后再进行安装。

```
sudo apt-get install software-properties-common
sudo add-apt-repository ppa:brightbox/ruby-ng
sudo apt-get update
```

安装包含ruby2.6的源之后，我们可以进行ruby2.6的安装。

```
sudo apt-get install ruby2.6 ruby2.6-dev zlib1g-dev libxml2-dev \
                       libsqlite3-dev postgresql libpq-dev \
                       libxmlsec1-dev curl make g++
```

安装完成之后，使用`ruby -v`可以进行版本的查看

```
ruby -v
```
输出结果：
```
ruby 2.6.6p146 (2020-03-31 revision 67876) [x86_64-linux-gnu]
```

## node.js的安装

之后我们再来安装node.js,同样的道理，也需要添加源之后进行安装。

```
curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt-get install nodejs
```

安装完成之后，使用
```
node -v
```
可以进行版本的查看,我的是v10.24.1 。

## bundle和yarn的安装

完成ruby和node.js基础软件的安装之后，我们需要安装bundle和yarn。因为Canvas-lms的大多数依赖项都是Ruby Gems，也是一个软件包管理系统，然后Canvas-lms使用Bundler,一个管理 Ruby 项目中 gem 依赖的最好工具，来进行依赖项的安装。

由于存在国内与国外网络的连接上的问题，我们首先需要更改gem的源，先查看gem的版本，建议高于2.6.x版本，之后进行gem源的更改。

```
gem -v
```
输出：
```
3.0.3
```

```
gem sources --add https://gems.ruby-china.com/ --remove https://rubygems.org/
gem sources -l
```

**确保只有 gems.ruby-china.com**

下面来进行bundler的的安装,在ubuntu中，执行第一条命令指定安装版本为2.1.4。

```
sudo gem install bundler --version 2.1.4
```

安装完成后应该执行bundle语句,不过首先还得进行源的进行修改

```
bundle config mirror.https://rubygems.org https://gems.ruby-china.com
```

如果有问题，可以查看网站:[](https://gems.ruby-china.com/)[https://gems.ruby-china.com/](https://gems.ruby-china.com/)。

源配置修改完成后，我们可以通过bundle来进行gem源的依赖的安装。

```
bundle _2.1.4_ install --path vendor/bundle
```

执行该条语句的时间稍微会比较长，而且如果ruby的版本不对会在此报错，所以一定要注意ruby的版本，如果没有报错则依赖安装成功，不放心的话可以在执行一遍上面一条命令，如果出现则安装成功

```
Bundle complete! 225 Gemfile dependencies, 322 gems now installed.
Bundled gems are installed into `./vendor/bundle`
```

通过bundle来安装依赖结束之后，我们再来进行yarn的安装，yarn同样也是一个依赖管理工具，不过是为node.js服务的。我们通过下列语句来进行yarn包的安装。注意，同样需要规定yarn的版本为1.10.1-1。

```
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
sudo apt-get update && sudo apt-get install yarn=1.10.1-1
sudo apt install python
```

安装好yarn之后，同样由于某些原因，我们需要进行安装源的配置,首先可以查看安装来源地址

```
yarn config get registry
```

执行后可以发现安装源在国外([https://registry.yarnpkg.com)](https://registry.yarnpkg.com%29/)，于是我们进行源的修改，在此我们使用淘宝的源

```
yarn config set registry https://registry.npm.taobao.org/
```

这样再重新执行
```
yarn config get registry
```
命令，就可以发现安装来源变成了淘宝源。安装源修改完成后，我们在`var/canvas`目录下再执行依赖的安装。

```
yarn install
```

同样这一步骤的过程所花的时间同样也会比较长，也比较考验机器配置，当最终出现
```
Done in xxx s
```
时，说明依赖安装完成。

# canvas-lms的配置

首先执行默认Rails的配置，我们仅需要使用canvas-lms自带的文件进行生效配置。

```
for config in amazon_s3 database \
  delayed_jobs domain file_store outgoing_mail security external_migration; \
  do cp config/$config.yml.example config/$config.yml; done
```

然后进行动态设置的配置，在这里我们同样使用自带的文件使配置直接生效

```
cp config/dynamic_settings.yml.example config/dynamic_settings.yml
```

由于我们不需要修改该文件配置，可以不执行下列命令。下列命令可以对该文件进行查看修改
```
nano config/dynamic_settings.yml
```

之后我们再进行数据库的相关的设置，同样先使用系统自带的配置文件，其次我们需要对部分地方进行修改

```
cp config/database.yml.example config/database.yml
nano config/database.yml
```

我们打开database.yml文件，文件内容如下,我们仅需对生产版本的部分进行修改。

```
# do not create a queue: section for your test environment
test:
  adapter: postgresql
  encoding: utf8
  database: canvas_test
  host: localhost
  username: canvas
  password: your_password
  timeout: 5000

development:
  adapter: postgresql
  encoding: utf8
  database: canvas_development
  password: your_password
  timeout: 5000

production:
  adapter: postgresql #使用的数据库类型，这里为postgresql
  encoding: utf8 #编码类型
  database: canvas_production #数据库名称
  host: localhost #数据库地址
  username: canvas #管理该数据库的用户名
  password: xxxxxxxxx #用户名密码
  timeout: 5000 #设置查询超时的时间
```

完成数据库配置文件的修改，我们需要进行出站邮件的配置，在canvas-lms中的通知很多是可以通过邮件来进行发送的，所以我们需要对其进行配置,执行下列命令：

```
cp config/outgoing_mail.yml.example config/outgoing_mail.yml
nano config/outgoing_mail.yml
```

我们同样仅需编辑该文件的Production部分，该部分配置请参考自己的smtp服务器的相关配置，这里采用的是阿里云的SMTP服务：

```
production:
  address: "smtpdm.aliyun.com" #邮件地址
  port: "465" #端口号
  user_name: "noreply@xxxxxx.cn" #用户名
  password: "xxxxxxxx" #密码
  authentication: "plain" # plain, login, or cram_md5 认证方式
  domain: "smtpdm.aliyun.com" # 邮件服务器的地址
  outgoing_address: "noreply@hiyiguo.cn" #出站邮件地址 
  ssl: true # 是否开启ssl
  default_name: "Instructure Canvas" # 设置发送邮件的用户名
```

这样设置好之后，我们便能通过邮件收到通知了。

现在我们再来设置可信URL的设置。

```
cp config/domain.yml.example config/domain.yml
nano config/domain.yml
```
同样只需要修改production的部分

```
production:
  domain: "canvas.example.com" #这里输入可信的URL，一般为部署的域名
  # whether this instance of canvas is served over ssl (https) or not
  # defaults to true for production, false for test/development
  ssl: true #是否开启ssl
  # files_domain: "canvasfiles.example.com"
```
最后来进行安全配置，我们仅需给 production 部分 的 encryption_key 设置一个至少20个字符的随机字符串（长度大于20即可）

```
cp config/security.yml.example config/security.yml
nano config/security.yml
```

```
production: &default
  # replace this with a random string of at least 20 characters
  encryption_key: djkdasu93i9huh23329j32nj32j32j32 #随意输入即可
  lti_iss: 'https://canvas.instructure.com'
```

# 构建运行的资产模块

Canvas需要先构建一些资产模块才能正常工作。首先，创建将存储生成的文件的目录。
```
cd /var/canvas
mkdir -p log tmp/pids public/assets app/stylesheets/brandable_css_brands
touch app/stylesheets/_brandable_variables_defaults_autogenerated.scss
touch Gemfile.lock
touch log/production.log
sudo chown -R $USER:$GROUP config/environment.rb log tmp public/assets \
                              app/stylesheets/_brandable_variables_defaults_autogenerated.scss \
                              app/stylesheets/brandable_css_brands Gemfile.lock config.ru
```

进行之后，开始进行最为重要，也是最容易产生各种各样错误信息的两步
```
yarn install
RAILS_ENV=production bundle exec rake canvas:compile_assets
sudo chown -R $USER:$GROUP public/dist/brandable_css
```

尤其是**第二条语句，是最容易出现各种问题的地方，在此尤其需要注意！！！**  
同样出现了如下情况的话，说明基本上是没有问题的，否则出现各种`rake adapted`的时候就会心态炸裂，建议去GitHub的issues进行查找所出现的问题。

```
ES-Check: there were no ES version matching errors!
Done in 257.64s.
--> Finished: 'js:webpack_production' in 257.88s
Finished compiling assets in 413.42s. Parallelism saved 112.08s (78.67%)
```

附：如果修改了canvas-lms的源码,最好执行下面的这条命令，然后在启动项目，才能让你的修改完全生效

```
RAILS_ENV=production bundle exec rake brand_configs:generate_and_upload_all
```

# 初始化数据库

我们需要生成数据库表并在数据库中添加初始数据。在canvas-lms安装根目录执行下面命令即可，执行命令后，会要求你设置 canvas-lms的默认管理员登录的电子邮件地址和登录密码，还会设置一个登陆后的提示名称，通常是您的组织名称，最后选择是否向canvas开发团队反馈使用信息，包括所有信息、不反馈任何信息和匿名反馈信息。需要执行下列命令：
```
RAILS_ENV=production bundle exec rake db:initial_setup
```
执行之后如果过程中有创建表的操作提示和让你进行相关初始化设置，设置完成后无错误信息，说明该步骤执行正常，然后我们可以进行下一步有关apache服务器的相关配置。

# apache服务器的相关配置

(注意：在以下的安装过程中间，如果终端提示需要进行相关操作，如`service apache2 restart`之类的命令，请按照终端提示进行执行，在下面不再赘述)  
首先我们需要安装apache和passenger的软件包

```
sudo apt-get install passenger libapache2-mod-passenger apache2
```

之后我们需要让rewrite生效

```
sudo a2enmod rewrite
```

然后我们需要编辑passenger的相关配置，我们需要对`/etc/apache2/mods-enabled/`目录中的 _passenger.conf_ 和 _passenger.load_ 分别进行修改。

对 _passenger.load_ ，我们需要修改成如下内容：

```
LoadModule passenger_module /usr/lib/apache2/modules/mod_passenger.so
PassengerRoot /usr
PassengerRuby /usr/bin/ruby
```

对passenger.conf,我们需要修改成如下内容：

```
<IfModule mod_passenger.c>
  PassengerRoot /usr/lib/ruby/vendor_ruby/phusion_passenger/locations.ini
  PassengerDefaultUser canvas
  PassengerDefaultRuby /usr/bin/passenger_free_ruby
</IfModule>
```

这些配置完成之后，我们需要apache2支持ssl，于是我们执行下列命令使其生效

```
sudo a2enmod ssl
```

生效之后，我们再来编辑有关canvas-lms系统的apache的配置，首先我们需要将默认的apache2的界面给删除掉（或者解除链接），之后我们新建有关canvas-lms的配置文件。

```
sudo unlink /etc/apache2/sites-enabled/000-default.conf
sudo nano /etc/apache2/sites-available/canvas.conf
```
参考配置如下：
```
# apache2.4以上的版本
<VirtualHost *:80>
  ServerName canvas.example.com # canvas 所在服务器地址或域名，在此填本机的地址或域名即可
  ServerAlias canvasfiles.example.com
  ServerAdmin youremail@example.com # 可修改
  DocumentRoot /var/canvas/public # 将canvas安装路径下public目录放到apache web容器内，供用户访问
  RewriteEngine On
  RewriteCond %{HTTP:X-Forwarded-Proto} !=https
  RewriteCond %{REQUEST_URI} !^/health_check
  RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI} [L]
  ErrorLog /var/log/apache2/canvas_errors.log
  LogLevel warn
  CustomLog /var/log/apache2/canvas_access.log combined
  SetEnv RAILS_ENV production
  <Directory /var/canvas/public>
    Options All
    AllowOverride All
    Require all granted
  </Directory>
</VirtualHost>
<VirtualHost *:443>
  ServerName canvas.example.com
  ServerAlias canvasfiles.example.com
  ServerAdmin youremail@example.com
  DocumentRoot /var/canvas/public
  ErrorLog /var/log/apache2/canvas_errors.log
  LogLevel warn
  CustomLog /var/log/apache2/canvas_ssl_access.log combined
  SSLEngine on
  BrowserMatch "MSIE [17-9]" ssl-unclean-shutdown
  # the following ssl certificate files are generated for you from the ssl-cert package.
  SSLCertificateFile /etc/ssl/certs/ssl-cert-snakeoil.pem
  SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key
  SetEnv RAILS_ENV production
  <Directory /var/canvas/public>
    Options All
    AllowOverride All
    Require all granted
  </Directory>
</VirtualHost>
```

之后我们让该文件生效，执行下列命令:

```
sudo a2ensite canvas
```

# redis的安装和配置

在apache配置完成之后，我们对redis进行安装和配置，首先我们开始redis的安装，执行下列命令：

```
sudo add-apt-repository ppa:redislabs/redis
sudo apt-get update
sudo apt-get install redis
```

安装完成之后我们需要让redis能够实现在后台运行，于是我们找到redis的配置文件，一般在`/etc/redis/redis.conf`中，于是我们编辑该文件，然后查找到`daemonize`这一行，将`daemonize no`改为`daemonize yes`，修改之后保存退出，之后开始运行redis

```
redis-server /etc/redis/redis.conf
```

启动之后没有像之前一样打出一大堆的内容，因为我们用后台启动的缘故，确认是否启动，可以使用`ps -ef|grep redis`命令,若能看到含有redis的相关内容，则说明redis运行成功了。

然后我们让canvas-lms实现对redis的支持，先创建cache_store.yml,执行下列有关操作：

```
cd /var/canvas
sudo cp config/cache_store.yml.example config/cache_store.yml
sudo nano config/cache_store.yml
sudo chown canvasuser config/cache_store.yml
```

其中文件内容如下：

```
test:
  cache_store: redis_store
development:
  cache_store: redis_store
production:
  cache_store: redis_store
```

再创建redis.yml,执行下列操作：

```
sudo cp config/redis.yml.example config/redis.yml
sudo nano config/redis.yml
sudo chown canvasuser config/redis.yml
```

其中文件内容如下（其他内容可以注释掉，或者根据内容进行修改）：

```
production:
  servers:
    - redis://localhost
```

# 准备开始

我们先添加canvas-lms的启动项，执行操作如下：
```
sudo ln -s /var/canvas/script/canvas_init /etc/init.d/canvas_init
sudo update-rc.d canvas_init defaults
sudo /etc/init.d/canvas_init start
```

执行完成之后，我们再重启apache，执行

```
sudo service apache2 restart
```

打开网站即可访问了。