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

[更新:2021年7月6日]

さくらのVPSで提供する「スタートアップスクリプト」に関するページです。
スタートアップスクリプトはサーバーの新規追加やOS再インストール時に任意のスクリプトを実行して、パッケージのインストールや各種設定作業の自動化等を簡単に実現できる機能です。
スタートアップスクリプトには弊社側で用意した「さくらインターネット公式スクリプト」とお客様で記述して登録できる「マイスクリプト」があります。
なお、「マイスクリプト」は自身で利用するだけでなく、他ユーザが利用できるように公開(シェア)することも可能です。

仕様

提供プラン 全てのプラン
バージョン 全てのバージョン
マイスクリプト 10個まで

注意事項

  • 本機能は「標準OSインストール」でのみご利用いただけます。
  • 本機能を用いてコントロールパネルに入力するパスワードを含む値は、VPS内部のスクリプト及び実行ログなどに残留します。詳しくは、 スタートアップスクリプトの動作 もしくはご利用されるスクリプトをご確認ください。
  • コントロールパネルへ「IPアドレスログイン」の場合はご利用いただけません。
  • マイスクリプトをシェアした場合、全てのユーザに公開されスクリプトの利用が可能となります。
  • シェアする際は文章 基本約款(PDF形式) 及び さくらのVPSサービス約款(PDF形式) への同意をお願いします。

画面説明

注目スクリプト

ユーザー間でシェアされているスクリプトの中から、さくらインターネットがオススメするスクリプトをピックアップ表示しています。

さくらインターネット公式スクリプト

さくらインターネットが提供しているスタートアップスクリプトです。

ユーザースクリプト

ユーザーがシェアしているスクリプトです。

すべてのスクリプト

利用できるすべてのスクリプトです。

利用手順

マイスクリプトの作成

「マイスクリプト」から「スクリプト新規作成」をクリックします。

名前 スクリプトの名前を記入します
説明 スクリプトについての説明を記入します
利用可能OS スクリプトを実行することができるOSを選択します
スクリプト本文 任意のスクリプトを記述します
パラメータ スクリプト本文で使用する置換対象文字列を指定します
パケットフィルタ設定 パケットフィルタの有効/無効を設定します
公開設定 マイスクリプトの公開(シェア)/非公開を設定します

「作成」をクリックするとマイスクリプトの新規作成は完了です。

マイスクリプトの編集・削除

「マイスクリプト」から対象のスクリプトを選択します。

対象の自分のスクリプトを選択し、右上の「編集」または最下部の「スクリプトを削除」をクリックします。

マイスクリプトのシェア

対象のマイスクリプトを選択して「公開」をクリックします。

「基本約款」及び「さくらのVPS サービス約款」を確認します。
同意いただければ「同意する」にチェックを入れて「スクリプトを公開」をクリックします。

不正スクリプトの報告

基本約款等に定める「禁止事項」に該当するおそれのあるスクリプトを報告する場合は三点リーダをクリックします。
不正内容を記述して「不正スクリプトを報告」をクリックします。

スクリプトを利用したサーバー作成

ここでは「マイスクリプト」で作成したスクリプトを利用して、サーバーを作成する例をご紹介します。

「マイスクリプト」から対象のスクリプトを選択します。

契約中のサーバーで利用する

「スクリプトを利用」をクリックします。

「サーバーを選択」からスクリプトを利用するサーバーを選択して「スクリプトを利用」をクリックします。

OS再インストールの画面に切り替わります。
利用するスクリプトの「標準OS」と「スタートアップスクリプト」が自動で選択されます。
パスワードなどの必要な情報を入力して、OS再インストールを実行してください。

サーバーを新規追加して利用する

「サーバーを新規追加して利用する」をクリックします。

サーバ新規追加の画面に切り替わります。
ご希望のゾーンやプランなどを選択してサーバをご契約ください。
※ 「サーバー設定」には利用するスクリプトの「標準OS」と「スタートアップスクリプト」が自動で選択されています。

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

スタートアップスクリプトは、サーバーの初回起動時後に以下の動作が行われます。

重要

本機能を用いてコントロールパネルに入力するパスワードを含む値は、スクリプト及び実行ログ、スクリプト内部の処理で作成されるファイルなどのVPS内部に残留します。
必要がある場合は、下記の内容を参考に削除ください。

CentOS の場合

  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 の実行処理を削除

ヒント

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

CentOS以外 の場合

  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の実行処理を削除

さくらインターネット公式スクリプト一覧

弊社側で用意しているスクリプトにつきましては以下をご確認ください。

種別 スクリプト CentOS 7 CentOS 8 CentOS Stream 8 Ubuntu 18 Ubuntu 20 パケットフィルタデフォルト設定
開発管理 gitlab ◯※ ◯※ OFF
開発管理 Redmine OFF
開発管理 Jenkins OFF
開発管理 Node-RED OFF
WEBサイト制作 baserCMS ◯※ ◯※ OFF
WEBサイト制作 LAMP OFF
WEBサイト制作 WordPress OFF
更新 yum_update ON
更新 apt-update-upgrade ON
コンテナ DockerCompose ON
コンテナ Kubernetes-master OFF
コンテナ Kubernetes-worker OFF
ストレージ ownCloud OFF
ストレージ Nextcloud OFF
GUI操作 GNOME-XRDP OFF
GUI操作 Cockpit OFF
ゲーム FactorioHeadlessServer OFF
ゲーム Minecraft Server(Java版) OFF
ゲーム Minecraft Server(統合版) 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
wiki GROWI OFF

※ VPS契約時にはご選択いただけません。サーバ契約後、コントロールパネルのサーバ詳細にある「各種設定」からOS再インストールを実行する際にご選択ください。

certbot-autoを利用した証明書管理の注意について

上記「証明書」を利用したスタートアップスクリプトでは、certbot-autoを利用して証明書の管理を実施していました。
当該スクリプトを利用されている方は、 certbot-auto更新 をご確認ください。

Q&A

マイスクリプトに関するQ&A

Q. スクリプトの導入や設定代行を依頼することはできますか?
A.いいえ。導入や設定代行は承っておりません。

Q. スクリプトの挙動がおかしいのですが、調査してもらえますか?
A.いいえ。マイスクリプトにつきまして、基本的に弊社での調査はいたしかねます。サーバー起動後の挙動となりますのでお客様にてご対応をお願いいたします。
OSを再インストールしていただき、手動でスクリプトをコピー・実行して調査するなどのご対応をお勧めいたします。
なお、「マイスクリプトがサーバーにコピーされていない」など弊社側の設備に問題がある場合につきましては、お手数ではございますがお問い合わせ窓口よりご連絡ください。

公開されているスクリプトに関するQ&A

Q.悪意のあるスクリプトが公開されていました。報告先などはありますか?
A.はい。該当スクリプトの「三点リーダー」をクリックすることでご報告いただけます。ご報告いただいた内容は弊社で確認し、適宜対応いたします。
※ ご報告に対して個別の返信はいたしません。ご了承ください。

さくらインターネット公式スクリプトに関するQ&A

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