Sshelf

Important

Sshelf is currently in Public Beta (v0.1.0-beta). While core features like the encrypted vault and terminal are functional, you may encounter bugs. We recommend backing up your APP_KEY and testing in a safe environment.

Sshelf (Secure Shelf) is a secure SSH credential manager and real-time web terminal built with Laravel 13, Livewire 3, and xterm.js. It allows you to manage multiple server credentials securely and access them directly from your browser.

Features

• Encrypted Vault: Server credentials (passwords/private keys) are encrypted at rest using industry-standard AES-256-GCM.
• Web Terminal: High-performance interactive terminal powered by xterm.js and Laravel Reverb.
• SSH Key Manager: Generate and manage Ed25519 SSH keys directly within the application.
• Role-Based Access Control (RBAC): Assign Admin or Viewer roles to restrict who can manage infrastructure vs who can only access it.
• Real-Time Health Monitoring: Periodically fetches CPU, Memory, and Disk usage via SSH and broadcasts live updates to your dashboard.
• API & CLI Bridge: Programmatic access with token-based (Sanctum) authentication, allowing external tools to interact with your vault and execute commands.
• Audit Trails: Detailed UI for viewing connection history, including IP addresses, timestamps, and session durations.
• Organization: Group servers with smart tags and search for easy management.
• Mobile Friendly: Fully responsive design with card views optimized for small screens.
• Import/Export: Easily migrate data via JSON, CSV, or standard SSH config files.

Deployment

Self-Hosting (Docker)

Sshelf is optimized for self-hosting using FrankenPHP. The simplest way to deploy is using Docker Compose:

1. Clone the repository and enter the directory.
2. Create your .env file:

   cp .env.example .env

3. Generate an application key:

   docker run --rm -v $(pwd):/app php:8.3-cli php /app/artisan key:generate --show

   Paste this key into your .env as APP_KEY.
4. Start the stack:

   docker-compose up -d

Sshelf will be available at http://localhost:8080.

Sponsorship & Support

Sshelf is open-source and free to use. If you find it useful and want to support its continued development, please consider sponsoring the project:

Your support helps cover hosting costs and keeps the project alive!

Configuration

• Encryption: Keep your APP_KEY safe. If lost, you will lose access to all stored server passwords.
• Background Worker: Sshelf uses a background process for the terminal. Ensure PHP_BINARY_PATH in your .env points to your CLI PHP binary.
• Reverb: Real-time communication is handled by Laravel Reverb. Ensure your firewall allows WebSocket traffic on the configured port.

Installation (Manual)

1. Clone the repository:

   git clone https://github.com/syofyanzuhad/sshelf.git
   cd sshelf

2. Install dependencies:

   composer install
   npm install

3. Setup environment:

   cp .env.example .env
   php artisan key:generate

4. Run migrations:

   php artisan migrate

5. Build assets:

   npm run build

Development

Start the development servers:

php artisan reverb:start
npm run dev

Security

Sshelf is designed with security in mind:

• Authorization: Strict Laravel Policies ensure users only access their own servers.
• Privacy: Terminal sessions are broadcast over private, authenticated WebSocket channels.
• Audit: Every access attempt is logged for complete transparency.

License

The Sshelf project is open-source software licensed under the MIT license.