Atuin

最終更新日: 2026年4月22日

テンプレート説明

Atuinは、シェルの操作履歴をエンドツーエンド暗号化して複数マシン間で同期できる、オープンソースのシェル履歴管理ツールです。PostgreSQLをバックエンドに利用したセルフホスト型の同期サーバーを構築することで、コマンド履歴を完全に自分のインフラ上で管理できます。bash、zsh、fishなど主要シェルに対応しています。

本テンプレートはインストール完了後もサービスは停止状態を維持します。また、新規ユーザー登録はデフォルトで無効化されています。以下の手順に従ってセットアップ・起動を行い、必要なタイミングでのみ登録を開放してください。

スタートアップスクリプトのテンプレートを利用してサーバー作成を行う手順はご利用ガイドを参照してください。

仕様

対応OSイメージ

Ubuntu 24.04 LTS

主要ソフトウェア

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

その他

最小システム要件

• CPU: 1コア以上
• メモリ: 1GB以上
• ディスク容量: 10GB以上（履歴データ量に応じて増加）
• ネットワーク: パブリックIPアドレス

利用手順

管理スクリプト一覧

セキュリティグループの設定

Step 1: VPSへの接続

【VPS側】 SSHクライアントを使用してVPSに接続します。

# ssh root@<IPアドレス>

Step 2: 初期セットアップ

【VPS側】 Dockerイメージの取得と初期準備を行います。

# /root/atuin-manage.sh setup

Step 3: サービスの起動

【VPS側】 Atuinサーバーを起動します。

# /root/atuin-manage.sh start

Step 4: HTTPS設定

【VPS側】 AtuinクライアントはHTTPS接続が必要です。ドメインのDNSレコードをVPSのIPアドレスに向けた上で、Let’s Encrypt証明書を取得してください。

# /root/atuin-letsencrypt.sh -e [email protected]

Step 5: クライアントの登録

【VPS側】 新規ユーザー登録を一時的に有効化します。

# /root/atuin-manage.sh register-on

【手元のPC側】 Atuinクライアントをインストールします。

$ curl --proto '=https' --tlsv1.2 -LsSf https://setup.atuin.sh | sh
$ source ~/.bashrc   # bashの場合
# または
$ source ~/.zshrc    # zshの場合

$ export PATH="$HOME/.atuin/bin:$PATH"
$ echo 'export PATH="$HOME/.atuin/bin:$PATH"' >> ~/.bashrc
$ source ~/.bashrc

【手元のPC側】 アカウントを登録します。register を実行してから login に進んでください。

$ atuin register -u USERNAME -e 'EMAIL' -p 'PASSWORD'

【手元のPC側】 暗号化キーの入力を求めるプロンプトが表示されます。

Please enter encryption key [blank to use existing key file]:

初めてのマシンの場合はそのままEnterを押してください。新しいキーが自動生成されます。2台目以降のマシンの場合は、既存マシンで atuin key を実行して取得したキーを入力してください。

【手元のPC側】 登録完了後、暗号化キーを必ず控えておきます。2台目以降のマシンで同期する際に必要です。

$ atuin key

表示されたキーを安全な場所に保存してください。紛失した場合は復元できません。

【手元のPC側】 ~/.config/atuin/config.toml にサーバーアドレスを設定します。テキストエディタで開き、sync_address の行を編集してください。

$ nano ~/.config/atuin/config.toml

sync_address = "https://<your-domain>"

【手元のPC側】 ログインして履歴を同期します。

$ atuin login -u USERNAME -p 'PASSWORD'
$ atuin sync

【VPS側】 全クライアントの登録が完了したら、登録を無効化します。

# /root/atuin-manage.sh register-off

Step 6: ドメイン変更（オプション）

【VPS側】 インストール後にドメインを変更する場合は以下のスクリプトを使用します。

# /root/atuin-change-domain.sh -d new.domain.com

Step 7: システム診断

【VPS側】 サーバーの稼働状態を確認するには診断スクリプトを実行します。

# /root/atuin-diagnose.sh

アプリケーションの具体的な利用方法につきましては、サービス開発元やサービス提供元の公式サイト、Wikiなどで最新情報をご確認ください。

外部リンク