スタートアップスクリプトについて

スタートアップスクリプト概要

「スタートアップスクリプト」機能はVPS作成完了後の初回起動時に任意の内容を記述したスクリプトを実行し、パッケージのインストールや各種設定作業の自動化などを簡単に実現できる機能です。

スタートアップスクリプトには、当社側で用意している「パブリックスクリプト」と、お客様が記述したスクリプトを登録できる「カスタムスクリプト」がございます。

スタートアップスクリプト ご利用条件

・本機能は「標準OSインストール」でのみご利用いただけます。
・さくらのVPS バージョン v3/v4(2012年3月29日以降のプランにて申し込まれたVPS)でご利用いただけます。
※ご契約中のVPSのバージョンの確認方法はこちらをご覧ください。
・IPアドレスログインの場合はご利用いただけません。

 

スタートアップスクリプト ご利用方法

1. OS再インストール時に実行

(1) 「さくらのVPS」のコントロールパネルにログイン。
(2) サーバ一覧が表示されたら「OSインストール」を実施するVPSを選択。
(3) 右上の「各種設定」をクリックして「OSインストール」を選択。

(4) 「標準OS」を選択。

(5) インストールOS/管理ユーザのパスワードを入力。

(6) スタートアップスクリプトのプルダウンより実行スクリプトを指定。

(7) 「設定内容を確認する」を選択。
(8) 入力内容に問題が無ければ「インストールを実行する」をクリック。
(9) OSの再インストールが始まります。
(10) 再インストール完了後、VPSが自動で起動しスタートアップスクリプトが実行されます。

2. VPS契約時に実行

※ 一部のスクリプトは対応しておりませんのでご注意ください

(1) 「さくらのVPS」のコントロールパネルにログイン。
(2) サーバ一覧が表示されたら「+サーバ新規追加」をクリック。
(3) 利用するゾーン、ストレージ及びプランを選択し、任意でサーバ名と説明を入力。

(4) インストールOS/管理ユーザのパスワードを入力。

(5) スタートアップスクリプトのプルダウンより実行スクリプトを指定。

(6) 支払い方法を適宜入力
(7) お申し込み確認画面で申し込み内容と約款の確認をし、問題なければ「同意する」をチェック
(8) 入力内容に問題が無ければ「申し込み」をクリック。
(9) VPSの新規作成が順次実施されます。
(10) VPSの作成完了後、お客様にてVPSを初回起動した際にスタートアップスクリプトが実行されます。

カスタムスクリプトの登録

(1) 「さくらのVPS」のコントロールパネルにログイン。
(2) 左メニューバーより「スクリプト」をクリック。
(3) 画面右上にある「カスタムスクリプトの登録」をクリック。

(4) カスタムスクリプト情報を入力し、「保存」をクリック。
※10000文字を超えるスクリプトはご登録いただけません。

 

スタートアップスクリプトの動作

初回起動時後のVPS内で以下の動作が行われます。

CentOS7 の場合

  1. OS起動時、systemdで管理されている startup.service が ”/root/.sakuravps/startup.sh”を実行
  2. startup.shより ”/root/.sakuravps/startup.done” を作成
  3. startup.shより ”/etc/profile.d/startup.sh” を作成し、スクリプトが実行中にログインした場合にはメッセージを表示する。
  4. startup.shが、指定されたスクリプト(“/root/.sakuravps/VPS名.sh“に配置)をbashとして実行
  5. スクリプトが実行され、ログが”/root/.sakuravps/startup.log”に出力される
  6. スクリプトが正しく(終了コードが”0″)終了すると”systemdから/startup.service の実行処理を削除

※ CentOS7の場合、StartupScript完了前に VNCコンソールおよびSSHログインが可能となります。
※ スタートアップスクリプトの実行状況は”/root/.sakuravps/startup.log”をご確認ください。

CentOS7以外の場合

  1. OS起動時、/etc/rc.localが/root/.sakuravps/startup.shを実行
  2. startup.shより ”/root/.sakuravps/startup.done” を作成
  3. startup.shより ”/etc/profile.d/startup.sh” を作成し、スクリプト実行中にログインした場合にはメッセージを表示する。
  4. startup.shが、指定されたスクリプト(“/root/.sakuravps/VPS名.sh“に配置)をbashとして実行
  5. スクリプトが実行され、ログが”/root/.sakuravps/startup.log”に出力される
  6. スクリプトが正しく(終了コードが”0″)終了すると、”/etc/rc.local”から/root/.sakuravps/startup.shの実行処理を削除

 

パブリックスクリプト一覧

*1 VPS契約時に実行可能
*2 OS再インストール時に実行可能

*1 *2 スクリプト名 概要
CentOS_LetsEncrypt CentOSにて Let’s EncryptにてSSL証明書を取得、nginxをインストールしWebサーバを構築します。
CentOS_Mastodon CentOSにて Let’s EncryptにてSSL証明書を取得をおよびMastodonインストールします。
CentOS_baserCMS CentOSにて baserCMS のセットアップを行います
CentOS_gitlab CentOSにて GitLab CE のセットアップを行います
CentOS_ownCloud CentOSにて ownCloudのセットアップを行います。
CentOS_LAMP CentOSにて Apache/MySQL/PHPのセットアップを行います
CentOS_Redmine CentOSにて Redmineのセットアップを行います
CentOS_ZabbixServer CentOSにて ZabbixServer のセットアップを行います
CentOS_ZabbixAgent CentOSにて ZabbixAgent のセットアップを行います
CentOS_SiteGuardLite-Apache CentOSにて SiteGuardLite-Apache のセットアップを行います
CentOS_vuls CentOSにて Vulsのセットアップを行います
CentOS_WordPress CentOSにて WordPress のセットアップを行います
CentOS_GNOME-XRDP CentOSにて GNOME-XRDP のセットアップを行います
CentOS_DockerCompose CentOSにて Docker および DockerCompose のセットアップを行います
CentOS_Jenkins CentOSにて Jenkins のセットアップを行います
CentOS_Node-RED CentOSにて Node-RED のセットアップを行います
CentOS_Nextcloud CentOSにて Nextcloud のセットアップを行います
CentOS_Restyaboard CentOSにて Restyaboard のセットアップを行います
CentOS_Cockpit CentOSにて Cockpit のセットアップを行います
Ubuntu_Netbox Ubuntuにて Netbox のセットアップを行います
Ubuntu_Crowi Ubuntuにて Crowi のセットアップを行います
Ubuntu_DockerCompose Ubuntuにて Docker および DockerCompose のセットアップを行います
Ubuntu_ufw Ubuntuにて iptables を停止し、ufw のセットアップを行います
Ubuntu_ZabbixAgent Ubuntuにて ZabbixAgent のセットアップを行います
Ubuntu_ZabbixServer Ubuntuにて ZabbixServer のセットアップを行います
Ubuntu_Jenkins Ubuntuにて Jenkinsのセットアップを行います
Ubuntu_Prometheus Ubuntuにて Prometheusのセットアップを行います
Ubuntu_apt-get_update_upgrade Ubuntuにて apt-getコマンドにてパッケージの更新を行います
Ubuntu_Gogs Ubuntuにて Gogsのセットアップを行います
Ubuntu_Gitea Ubuntuにて Giteaのセットアップを行います
Ubuntu_CodiMD Ubuntuにて CodiMDのセットアップを行います
Ubuntu_Setup Ubuntuにて いくつかの初期設定をコンパネから実施いたします

Q&A

Q. カスタムスクリプトの導入や設定代行を依頼することはできますか?

いいえ。導入や設定代行は承っておりません。ご了承ください。

 

Q. カスタムスクリプトでの挙動がおかしいのですが、調査いただけますか?

いいえ。カスタムスクリプトにつきまして基本的には弊社での調査はいたしかねます。
VPS起動後の挙動となりますのでお客様にてご対応をお願いいたします。

OSを再インストールをしていただき、手動でスクリプトをコピー・実行をしていただき調査いただくなどのご対応をお勧めいたします。

ただし、「カスタムスクリプトがVPSにコピーされていない」など、弊社側の設備に問題がある場合につきましては、お手数ではございますがお問い合わせ窓口よりご連絡ください。

 

Q. パブリックスクリプトが正常に動作しません。

今一度、OS再インストールよりスタートアップスクリプトをお試しいただけますでしょうか。
問題が解決しない場合、お手数ではございますがお問い合わせ窓口よりご連絡ください。
※ 弊社の検証環境にて動作確認を行います。基本的にお客様のVPSを操作・設定することはございません。

ページの先頭へ