GitHub/butterfly
1
0
Fork 0
mirror of https://github.com/paradoxxxzero/butterfly.git synced 2026-05-26 23:19:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Prettify README code blocks

Browse Source
This commit is contained in:
Philippe Vaucher
2016-09-06 08:59:23 +02:00
parent 2d3bed2fef
commit b72da2e4ef
1 changed files with 27 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@@ -24,16 +24,16 @@ Butterfly is a xterm compatible terminal that runs in your browser.
## Try it
```bash
$ pip install butterfly
$ pip install libsass # If you want to use themes
$ butterfly
``` bash
$ pip install butterfly
$ pip install libsass # If you want to use themes
$ butterfly
```
A new tab should appear in your browser. Then type
```bash
$ butterfly help
``` bash
$ butterfly help
```
To get an overview of butterfly features.
@@ -41,8 +41,8 @@ To get an overview of butterfly features.
## Run it as a server
```bash
$ butterfly.server.py --host=myhost --port=57575
``` bash
$ butterfly.server.py --host=myhost --port=57575
```
The first time it will ask you to generate the certificates (see: [here](http://paradoxxxzero.github.io/2014/03/21/butterfly-with-ssl-auth.html))
@@ -52,12 +52,12 @@ The first time it will ask you to generate the certificates (see: [here](http://
Systemd provides a way to automatically activate daemons when needed (socket activation):
```bash
$ cd /etc/systemd/system
# curl -O https://raw.githubusercontent.com/paradoxxxzero/butterfly/master/butterfly.service
# curl -O https://raw.githubusercontent.com/paradoxxxzero/butterfly/master/butterfly.socket
# systemctl enable butterfly.socket
# systemctl start butterfly.socket
``` bash
$ cd /etc/systemd/system
$ curl -O https://raw.githubusercontent.com/paradoxxxzero/butterfly/master/butterfly.service
$ curl -O https://raw.githubusercontent.com/paradoxxxzero/butterfly/master/butterfly.socket
$ systemctl enable butterfly.socket
$ systemctl start butterfly.socket
```
Don't forget to update the /etc/butterfly/butterfly.conf file with your server options (host, port, shell, ...)
@@ -74,7 +74,6 @@ If you want to motivate me to continue working on this project you can tip me, s
Client side development use [grunt](http://gruntjs.com/) and [bower](http://bower.io/).
## Credits
The js part is based on [term.js](https://github.com/chjj/term.js/) which is based on [jslinux](http://bellard.org/jslinux/).
@@ -82,24 +81,23 @@ The js part is based on [term.js](https://github.com/chjj/term.js/) which is bas
[Florian Mounier](http://paradoxxxzero.github.io/)
## License
```
butterfly Copyright (C) 2015 Florian Mounier
butterfly Copyright (C) 2015 Florian Mounier
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
```
## Docker
@@ -110,7 +108,7 @@ into this repository: https://registry.hub.docker.com/u/garland/butterfly/
Starting with login and password
```
``` bash
docker run \
--env PASSWORD=password \
-p 57575:57575 \
@@ -119,7 +117,7 @@ docker run \
Starting with no password
```
``` bash
docker run \
--env PORT=57575 \
-p 57575:57575 \