bssh 2.0.1

Parallel SSH command execution tool for cluster management
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

# bssh Documentation

Welcome to the bssh documentation. This documentation covers both the bssh client and bssh-server.

## Quick Links

- **[Quick Start Guide](./quick-start.md)** - Get bssh-server running in minutes
- **[Server Configuration](./architecture/server-configuration.md)** - Complete configuration reference
- **[Security Guide](./security.md)** - Security best practices
- **[Container Deployment](./container-deployment.md)** - Docker and Kubernetes deployment

## Documentation Index

### Getting Started

| Document | Description |
|----------|-------------|
| [Quick Start](./quick-start.md) | Installation and first run guide |
| [Container Deployment](./container-deployment.md) | Docker and Kubernetes deployment |

### Server Administration

| Document | Description |
|----------|-------------|
| [Server Configuration](./architecture/server-configuration.md) | Complete configuration reference |
| [Security Guide](./security.md) | Security best practices and hardening |
| [Audit Logging](./audit-logging.md) | Audit logging setup and integration |

### Client Documentation

| Document | Description |
|----------|-------------|
| [CLI Interface](./architecture/cli-interface.md) | Command-line interface documentation |
| [Interactive Mode](./architecture/interactive-mode.md) | TUI and interactive shell mode |
| [SSH Jump Hosts](./architecture/ssh-jump-hosts.md) | ProxyJump and jump host support |
| [Port Forwarding](./architecture/ssh-port-forwarding.md) | Local, remote, and dynamic forwarding |

### Migration Guides

| Document | Description |
|----------|-------------|
| [pdsh Migration](./pdsh-migration.md) | Migrating from pdsh to bssh |
| [pdsh Examples](./pdsh-examples.md) | pdsh-style command examples |
| [pdsh Options](./pdsh-options.md) | pdsh option compatibility |

### Architecture

| Document | Description |
|----------|-------------|
| [Architecture Overview](./architecture/README.md) | System architecture overview |
| [SSH Client](./architecture/ssh-client.md) | SSH client implementation |
| [SSH Config Parser](./architecture/ssh-config-parser.md) | SSH config file parsing |
| [Executor](./architecture/executor.md) | Parallel execution engine |
| [TUI](./architecture/tui.md) | Terminal user interface |
| [Exit Codes](./architecture/exit-code-strategy.md) | Exit code handling |

### Man Pages

Man pages are located in [docs/man/](./man/):

| Man Page | Section | Description |
|----------|---------|-------------|
| [bssh(1)](./man/bssh.1) | 1 | bssh client manual |
| [bssh-server(8)](./man/bssh-server.8) | 8 | bssh-server administration manual |
| [bssh-keygen(1)](./man/bssh-keygen.1) | 1 | SSH key generation tool manual |

### Shell Integration

| Document | Description |
|----------|-------------|
| [Shell Config](./shell-config/README.md) | Shell integration and completion |

## Installation

### From Binary

```bash
# Download and install binaries
curl -LO https://github.com/lablup/bssh/releases/latest/download/bssh-linux-amd64.tar.gz
tar xzf bssh-linux-amd64.tar.gz
sudo mv bssh bssh-server bssh-keygen /usr/local/bin/
```

### From Source

```bash
git clone https://github.com/lablup/bssh.git
cd bssh
cargo build --release
sudo cp target/release/bssh /usr/local/bin/
sudo cp target/release/bssh-server /usr/local/bin/
sudo cp target/release/bssh-keygen /usr/local/bin/
```

### Man Page Installation

```bash
sudo install -Dm644 docs/man/bssh.1 /usr/share/man/man1/bssh.1
sudo install -Dm644 docs/man/bssh-keygen.1 /usr/share/man/man1/bssh-keygen.1
sudo install -Dm644 docs/man/bssh-server.8 /usr/share/man/man8/bssh-server.8
sudo mandb
```

## Components

### bssh (Client)

A high-performance SSH client that can be used as a drop-in replacement for OpenSSH while also providing parallel execution capabilities for cluster management.

```bash
# Single host (SSH compatibility)
bssh user@host

# Multiple hosts
bssh -H host1,host2,host3 'uptime'

# Using clusters
bssh -C mycluster 'hostname'
```

### bssh-server

A lightweight SSH server designed for container environments with built-in audit logging, file transfer filtering, and comprehensive security controls.

```bash
# Generate configuration
bssh-server gen-config -o /etc/bssh/server.yaml

# Generate host key
bssh-server gen-host-key -t ed25519 -o /etc/bssh/ssh_host_ed25519_key

# Start server
bssh-server -c /etc/bssh/server.yaml
```

### bssh-keygen

SSH key generation tool compatible with OpenSSH key formats.

```bash
# Generate Ed25519 key (recommended)
bssh-keygen

# Generate RSA key
bssh-keygen -t rsa -b 4096

# Generate with custom comment
bssh-keygen -C "user@hostname"
```

## Support

- **Issues**: [GitHub Issues](https://github.com/lablup/bssh/issues)
- **Repository**: [GitHub](https://github.com/lablup/bssh)

## License

Apache License 2.0