スタートアップスクリプト¶
[更新:2021年2月3日]
さくらのVPSで提供する「スタートアップスクリプト」に関するページです。
スタートアップスクリプトはサーバの新規追加やOS再インストール時に任意のスクリプトを実行して、パッケージのインストールや各種設定作業の自動化等を簡単に実現できる機能です。
スタートアップスクリプトには弊社側で用意した「さくらインターネット公式スクリプト」とお客様で記述して登録できる「自分のスクリプト」があります。
なお、「自分のスクリプト」は自身で利用するだけでなく、他ユーザが利用できるように公開（シェア）することも可能です。
注意事項¶
- 本機能は「標準OSインストール」でのみご利用いただけます。
- コントロールパネルへ「IPアドレスログイン」の場合はご利用いただけません。
- 自分のスクリプトをシェアした場合、全てのユーザに公開されスクリプトの利用が可能となります。
- シェアする際は文章 基本約款（PDF形式） 及び さくらのVPSサービス約款（PDF形式） への同意をお願いします。
画面説明¶
自分のスクリプト¶
お客様にて自由にスクリプトの登録や編集が可能です。
作成したスクリプトは「private」として自身で使うだけでなく、「shared」にすることで他のユーザーも利用が可能になります。
さくらインターネット公式スクリプト¶
弊社側で用意しているスタートアップスクリプトです。
「もっと見る」をクリックすることで、より多くのスクリプトが表示されます。
利用手順¶
自分のスクリプトの作成¶
左側のメニューから「スクリプト」を選択します。
右側の画面に作成済みのスクリプトの一覧が表示され、選択することで編集や削除などが行なえます。
新規でスクリプトを作成する場合は、右上の「自分のスクリプトを追加」ボタンをクリックします。
スクリプト作成画面で作成するスクリプトの情報を入力して、「保存」ボタンをクリックします。
| 名前 | スクリプトの名前を記入します |
|---|---|
| 説明 | スクリプトについての説明を記入します |
| 利用可能OS | スクリプトを実行することができるOSを選択します |
| スクリプト | 任意のスクリプトを記述します |
| パラメータフィールド | スクリプト本文で使用する置換対象文字列を指定します |
| パケットフィルタ設定 | パケットフィルタの有効/無効を設定します |
自分のスクリプトのシェア¶
対象の自分のスクリプトを選択し、右上の「スクリプトをシェアする」をクリックします。
「基本約款」及び「さくらのVPS サービス約款」を確認して同意していただいたのち、「注意事項に同意してスクリプトをシェアする」ボタンをクリックします。
シェアしたスクリプトは「Tweet」ボタンから Twitter にリンクなどの投稿が可能です。
不正スクリプトの報告¶
基本約款等に定める「禁止事項」に該当するおそれのあるスクリプトを報告する場合、該当スクリプトの右下の三点リーダをクリックし、不正内容を記述して「不正スクリプトを報告する」をクリックします。
スクリプトを利用したサーバ作成¶
利用するスクリプトをクリックします。
契約中のVPSに利用する¶
「サーバを選択してください」からスクリプトを利用するサーバを選択し、「契約中のVPSに利用する」をクリックします。
「OSインストール」画面に切り替わり、利用するスクリプトの「標準OS」と「スタートアップスクリプト」が自動で選択されます。
パスワードなどの必要な情報を入力して、OSインストールを実行してください。
新規にVPSを契約して利用する¶
「サーバを新規購入して利用する」をクリックします。
「サーバ新規追加」画面に切り替わります。ご希望のゾーンやプランなどを選択してサーバをご契約ください。
※ 「サーバ設定」には利用するスクリプトの「標準OS」と「スタートアップスクリプト」が自動で選択されています。
スタートアップスクリプトの動作¶
スタートアップスクリプトは、サーバの初回起動時後に以下の動作が行われます。
CentOS7 の場合¶
- OS起動時、systemdで管理されている startup.service が ”/root/.sakuravps/startup.sh”を実行
- startup.shより ”/root/.sakuravps/startup.done” を作成
- startup.shより ”/etc/profile.d/startup.sh” を作成し、スクリプトが実行中にログインした場合にはメッセージを表示する
- startup.shが、指定されたスクリプト(“/root/.sakuravps/VPS名.sh“に配置)をbashとして実行
- スクリプトが実行され、ログが”/root/.sakuravps/startup.log”に出力される
- スクリプトが正しく(終了コードが”0″)終了すると”systemdから/startup.service の実行処理を削除
ヒント
CentOS7の場合、StartupScript完了前に VNCコンソールおよびSSHログインが可能となります。
スタートアップスクリプトの実行状況は”/root/.sakuravps/startup.log”をご確認ください。
CentOS7以外 の場合¶
- OS起動時、/etc/rc.localが/root/.sakuravps/startup.shを実行
- startup.shより ”/root/.sakuravps/startup.done” を作成
- startup.shより ”/etc/profile.d/startup.sh” を作成し、スクリプト実行中にログインした場合にはメッセージを表示する
- startup.shが、指定されたスクリプト(“/root/.sakuravps/VPS名.sh“に配置)をbashとして実行
- スクリプトが実行され、ログが”/root/.sakuravps/startup.log”に出力される
- スクリプトが正しく(終了コードが”0″)終了すると、”/etc/rc.local”から/root/.sakuravps/startup.shの実行処理を削除
さくらインターネット公式スクリプト一覧¶
弊社側で用意しているスクリプトにつきましては以下をご確認ください。
| 種別 | スクリプト | CentOS 7 | CentOS 8 | Ubuntu 16 | Ubuntu 18 | Ubuntu 20 | パケットフィルタデフォルト設定 |
|---|---|---|---|---|---|---|---|
| 開発管理 | gitlab | ◯※ | – | – | – | – | OFF |
| 開発管理 | Redmine | ◯ | ◯ | – | – | – | OFF |
| 開発管理 | JupyterLab | ◯ | ◯ | – | – | – | OFF |
| 開発管理 | Jenkins | ◯ | ◯ | – | – | – | OFF |
| 開発管理 | Node-RED | ◯ | ◯ | – | – | – | OFF |
| WEBサイト制作 | baserCMS | ◯※ | ◯※ | – | – | – | OFF |
| WEBサイト制作 | LAMP | ◯ | ◯ | – | – | – | OFF |
| WEBサイト制作 | WordPress | ◯ | ◯ | – | – | – | OFF |
| 更新 | yum_update | ◯ | ◯ | – | – | – | ON |
| 更新 | apt-get-update-upgrade | – | – | ◯ | – | – | ON |
| 更新 | apt-update-upgrade | – | – | – | ◯ | ◯ | ON |
| コンテナ | DockerCompose | ◯ | ◯ | ◯ | ◯ | ◯ | ON |
| コンテナ | Kubernetes-master | ◯ | ◯ | – | – | – | OFF |
| コンテナ | Kubernetes-worker | ◯ | ◯ | – | – | – | OFF |
| ストレージ | ownCloud | ◯ | ◯ | – | – | – | OFF |
| ストレージ | Nextcloud | ◯ | ◯ | – | – | – | OFF |
| GUI操作 | GNOME-XRDP | ◯ | ◯ | – | – | – | OFF |
| GUI操作 | Cockpit | ◯ | ◯ | – | – | – | OFF |
| ドキュメント作成 | Crowi | – | – | ◯ | – | – | OFF |
| ゲーム | FactorioHeadlessServer | – | – | ◯ | ◯ | ◯ | OFF |
| ゲーム | Minecraft（Java版） | – | – | ◯ | ◯ | ◯ | OFF |
| ゲーム | Minecraft（統合版） | – | – | – | ◯ | ◯ | OFF |
| セキュリティ | SiteGuard Server Edition（Apache版） | ◯ | ◯ | – | – | – | OFF |
| セキュリティ | SiteGuard Server Edition（Nginx版） | ◯ | ◯ | – | – | – | OFF |
| セキュリティ | ufw | – | – | ◯ | ◯ | ◯ | OFF |
| 証明書＋SNS | Mastodon | ◯※ | ◯※ | – | – | – | OFF |
| 証明書＋メール | Mailserver | ◯※ | ◯※ | – | – | – | OFF |
| 証明書＋サーバー | Let’s Encrypt | ◯※ | ◯※ | – | – | – | OFF |
| 初期設定 | Setup | – | – | ◯ | ◯ | ◯ | OFF |
| データ可視化 | Apache Superset | – | – | – | ◯ | ◯ | OFF |
※ VPS契約時にはご選択いただけません。サーバ契約後、コントロールパネルのサーバ詳細にある「各種設定」からOS再インストールを実行する際にご選択ください。
certbot-autoを利用した証明書管理の注意について¶
上記「証明書」を利用したスタートアップスクリプトでは、certbot-autoを利用して証明書の管理を実施していました。
当該スクリプトを利用されている方は、 certbot-auto更新 をご確認ください。
Q&A¶
自分のスクリプトに関するQ&A¶
Q. スクリプトの導入や設定代行を依頼することはできますか？
いいえ。導入や設定代行は承っておりません。ご了承ください。
Q. スクリプトの挙動がおかしいのですが、調査いただけますか？
いいえ。自分のスクリプトにつきまして、基本的に弊社での調査はいたしかねます。
サーバ起動後の挙動となりますのでお客様にてご対応をお願いいたします。
OSを再インストールしていただき、手動でスクリプトをコピー・実行して調査するなどのご対応をお勧めいたします。
なお、「自分のスクリプトがサーバにコピーされていない」など、弊社側の設備に問題がある場合につきましては、お手数ではございますがお問い合わせ窓口よりご連絡ください。
公開されているスクリプトに関するQ&A¶
Q.悪意のあるスクリプトが公開されていました。報告先などはありますか？
はい。該当スクリプトの右下にある「三点リーダー」をクリックすることでご報告いただけます。ご報告いただいた内容は弊社で確認し、適宜対応いたします。
※ ご報告に対して個別の返信はいたしません。ご了承ください。
さくらインターネット公式スクリプトに関するQ&A¶
Q. スクリプトが正常に動作しません。
今一度、OS再インストールからスタートアップスクリプトをお試しいただけますでしょうか。問題が解決しない場合、お手数ではございますが お問い合わせ窓口 よりご連絡ください。
※ 弊社の検証環境にて動作確認を行います。基本的にお客様のサーバを操作・設定することはございません。