File: README.md

package info (click to toggle)
bashbro 1.13-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 124 kB
  • sloc: sh: 294; makefile: 2
file content (75 lines) | stat: -rw-r--r-- 2,372 bytes parent folder | download
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
# bashbro
A Bash-based web file browser - allowing you to remotely browse, stream, view documents and save files via your web browser. Runs on Windows via WSL. 

![Bashbro Usage](https://raw.githubusercontent.com/victrixsoft/bashbro/assets/assets/bashbro_usage.png)
# Usage
To start bashbro locally on port 5555: 
```
$> bashbro -s -p 5555
   -or- (condensed syntax)
$> bashbro -sp5555
```
To start bashbro on port 7878, jailing to dir /tmp: 
```
$> bashbro -sp7878 -j/tmp 
```
Serve a single file on port 7878, jailing to
file /path/to/file: 
```
bashbro -sp7878 -j/path/to/file 
```

> [!NOTE]  
> When you jail to a file, bashbro will serve only that single file.  

### Remotely
___
To start bashbro on a remote server:

 1. Copy bashbro to the remote server
  ```
    scp bashbro <youruser>@<server name/ip>:
  ```
 2. Run bashbro
 ```
 ssh <youruser>@<server name/ip> ./bashbro -s -p=<port>
``` 
<p align="left" width="100%">
<i>After launching bashbro, open a browser to &#60;server name/ip>:&#60;port>.</i>
</p> 

***

![Bashbro Demo](https://raw.githubusercontent.com/victrixsoft/bashbro/assets/assets/bashbro_demo.gif)

# Downloading
> [!TIP]
> *To avoid downloading big images in `assets` branch, clone it like this:*<br> 
> `git clone https://github.com/victrixsoft/bashbro.git --depth 1`

You can also fetch and run **`bashbro`** directly `(e.g. get/run on port 6556)`: 
```
curl -O https://raw.githubusercontent.com/victrixsoft/bashbro/main/bashbro && chmod +x bashbro && ./bashbro -sp6556
```
```
wget -O bashbro https://raw.githubusercontent.com/victrixsoft/bashbro/main/bashbro && chmod +x bashbro && ./bashbro -sp6556
```

> [!TIP]
> *When using Chrome browser localhost may be blocked, in that case you can use your ip for instance 
> 192.168.1.55:8880 - no tickets on this plz, it's a Windows/Chrome thing.*


<p align="center" width="100%">
$${\color{orange} Requirements:}$$
</p>
<p align="center" width="100%">
    <img src="https://img.shields.io/badge/Bash-4EAA25?logo=gnubash&logoColor=fff">    
    <img src="https://img.shields.io/badge/Tree-v1.6+-green">
    <img src="https://img.shields.io/badge/Sed--orange">
    <img src="https://img.shields.io/badge/Socat--blue">
    <img src="https://img.shields.io/badge/getopt-T=4-yellow">
</p>
<p align="center" width="100%">
 <img src="https://www.gnu.org/graphics/gplv3-with-text-136x68.png">
</p>