NISLAB HP

同志社大学ネットワーク情報システム研究室の HP (https://nislab.doshisha.ac.jp) です。

もともとは WordPress で動いていたものを、 Nuxt.js(Vue.js) ・ contentful にマイグレーションしました。

構成（2021 年 7 月時点）

AWS Lightsail (Static IP を割り当て、大学へ DNS 申請をしています。)
Node.js
Apache
Let's Encrypt
Nuxt.js (Vue.js)
contentful

インフラ・サーバ周り（特に更新の必要はないため、ほぼ作業ログ）

Amazon Linux 2 を利用しています。ディストリビューションに応じてコマンドを読み替えてください。

AWS Lightsail（EC2）上で Apache が動いています。

サーバレスで公開したいところですが、大学側のドメイン（DNS）が A レコードしか登録申請することができないため、泣く泣くウェブサーバを立てて公開しています。

HTTPS 化については、Let's Encrypt を利用しており、Cron で証明書発行を自動化しています。

1. Web サーバ構築まで

https://docs.aws.amazon.com/ja_jp/AWSEC2/latest/UserGuide/ec2-lamp-amazon-linux-2.html

sudo yum update -y

sudo yum install -y httpd

sudo systemctl start httpd    # Apache の起動

sudo systemctl enable httpd   # インスタンスを再起動しても Apache が起動するように

2. git のインストール

sudo yum install -y git

3. Node.js / Yarn / Forever のインストール

https://docs.aws.amazon.com/ja_jp/sdk-for-javascript/v2/developer-guide/setting-up-node-on-ec2-instance.html

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.34.0/install.sh | bash

. ~/.nvm/nvm.sh

nvm install node

npm install -g yarn

4. リポジトリのクローン

sudo chmod -R 777 /var/www/html/

cd /var/www/html/

git clone https://github.com/Kenny-NISLab/nislab

# /var/www/html/nislab/.env

NUXT_ENV_SPACE_ID=""
NUXT_ENV_CTF_ACCESS_TOKEN=""
NUXT_ENV_BASE_URL=""

5. ルートディレクトリの変更

# /etc/httpd/conf/httpd.conf

- DocumentRoot "/var/www/html"
+ DocumentRoot "/var/www/html/nislab/dist"

Apache を再起動します。

sudo systemctl restart httpd

6. SSG

cd /var/www/html/nislab/

yarn generate

7. Redirect 設定

元々、 https://nislab.doshisha.ac.jp/class には佐藤先生が授業で利用するファイル群が保管されていましたが、 http://cs.nislab.io/class に移設しました。

そこで、元々のURLを叩いた時にリダイレクトされるように設定します。

# /etc/httpd/conf/httpd.conf

# ファイル末尾への追加でOKです。
+ Redirect /class http://cs.nislab.io/class

8. TLS (HTTPS) 化

https://docs.aws.amazon.com/ja_jp/AWSEC2/latest/UserGuide/SSL-on-amazon-linux-2.html

調査の結果、 AWS の ACM を利用するのは難しいため、 Let's Encrypt を利用して HTTPS 化を行いました。

基本は AWS のドキュメント通りにやればできます。

sudo yum update -y

sudo yum install -y mod_ssl

cd /etc/pki/tls/certs
sudo ./make-dummy-cert localhost.crt

# /etc/httpd/conf.d/ssl.conf

# 下記の行をコメントアウトします
SSLCertificateKeyFile /etc/pki/tls/private/localhost.key

sudo systemctl restart httpd

sudo wget -r --no-parent -A 'epel-release-*.rpm' https://dl.fedoraproject.org/pub/epel/7/x86_64/Packages/e/

sudo rpm -Uvh dl.fedoraproject.org/pub/epel/7/x86_64/Packages/e/epel-release-*.rpm

sudo yum-config-manager --enable epel*

sudo yum repolist all

# /etc/httpd/conf/httpd.conf

# Listen 80 ディレクティブを見つけて、その後ろに下記を追加する
<VirtualHost *:80>
  DocumentRoot "/var/www/html/nislab/dist"
  ServerName "doshisha.ac.jp"
  ServerAlias "nislab.doshisha.ac.jp"
</VirtualHost>

sudo systemctl restart httpd

sudo yum install -y certbot python2-certbot-apache

sudo certbot

# "Enter email address (used for urgent renewal and security notices)" というプロンプトが表示されたら、連絡先住所を入力し、Enter キーを押します。

# プロンプトが表示されたら Let's Encrypt のサービス利用規約に同意します。

# EFF のメーリングリストに登録するための承認で、「Y」または「N」と入力して Enter キーを押します。

# Certbot に、VirtualHost ブロックで入力した共通名およびサブジェクト代替名 (SAN) が表示されますので、「2」を入力して Enter キーを押します。

# /etc/crontab

# 下記のような行を追加する
39      1,13    *       *       *       root    certbot renew --no-self-upgrade

sudo systemctl restart crond

CI/CD

GitHub Actions を用いて Lightsail インスタンスにビルドしたファイル群をデプロイしています。

詳しくは、 .github/workflows/deploy.yml を読んでください。

簡単に説明すると、

Lightsail（EC2）内の /var/www/html/nislab/ に移動
Shell Script を実行（リビルド）

というものです。

トリガーは、 GitHub の main ブランチに push された時 と、 Contenful で記事が公開・更新・削除 された時です。

HP の更新が完了すると、 Slack に通知が届くようになっています。

Nuxt.js を編集したい方向け

Create `.env` File

NUXT_ENV_SPACE_ID=""
NUXT_ENV_CTF_ACCESS_TOKEN=""
NUXT_ENV_BASE_URL=""

Build Setup

# install dependencies
$ yarn install

# serve with hot reload at localhost:3000
$ yarn dev

# build for production and launch server
# $ yarn build
# $ yarn start

ディレクトリ構成

基本的なディレクトリ構成は公式ドキュメントを参考にしてください。以下に編集が必要になる可能性があるものを抜粋します。

├── assets
│   ├── _sass # グローバルCSS
│   └── images # 画像ファイル
├── components
│   ├── assets # SVG画像
│   ├── common # 一般的なコンポーネント
│   ├── layout # レイアウト関係
│   └── utility # 汎用コンポーネント
├── layout # レイアウト用
├── pages # 各ページ
└── static # 外部から読み込む可能性のある画像等

スタイルの編集

グローバルCSS及び各コンポーネントやページでのscoped cssはSass(SCSS)で記述しています。

グローバルCSS

assets/_sass内ではサイト全体で必要なスタイリングなどを行なっています。以下に各ファイルの詳細を記述します。

├── foundation
│   ├── mixin
│   │   ├── _fontsize.scss # フォントサイズ設定用mixin
│   │   └── _media-query.scss # メディアクエリ用mixin
│   ├── _base.scss # サイトのベース&contentful記事用
│   ├── _function.scss # 関数登録用
│   ├── _reset.scss # ブラウザのスタイルリセット用
│   └── _setting.scss # カラーやコンテンツ幅などの設定用
└── common.scss # import用

基本的にページ全体に関するスタイルの変更を行いたい場合にはこれらを編集してください。大体は_base.scssか_setting.scssになると思います。

scoped css

各コンポーネント及びページのスタイリングは各ファイル内でscopedとして記述しています。スタイルが必要な際にはそれらを編集してください。一応BEMっぽい設計になっています。

コンテンツの編集

Webサイトのコンテンツを編集したい際は基本的にcomponentsかpagesの中から必要なものを見つけ編集してください。各記事、研究業績などのcontentfulで管理しているものに関してはcontentfulから直接変更を行なってください。

nacal / nislab Goto Github PK

nislab's Introduction