📦 Get a clean, ready-to-go Linux box in seconds.
<p align="right">En | <a href="./docs/README-zh_cn.md">简</a> | <a href="./docs/README-zh_tw.md">繁</a></p>

<div align="center">

![logo](https://user-images.githubusercontent.com/5880908/53614582-6ebdfc80-3ba8-11e9-819e-d96a3f7c22f0.png)

# instantbox

Get a clean, ready-to-go Linux box in seconds.

[![Travis CI](https://badgen.net/travis/instantbox/instantbox)](https://travis-ci.com/instantbox/instantbox)
[![Docker](https://badgen.net/badge/icon/instantbox?icon=docker&label)](https://hub.docker.com/r/instantbox/instantbox)
![Python 3.6](https://badgen.net/badge/python/3.6/3776ab)
![Code Style Pep8](https://badgen.net/badge/code%20style/pep8/ffd343)
[![Chat on Telegram](https://badgen.net/badge/chat/on%20telegram/0088cc)](https://t.me/joinchat/HtYtxRSerOwrMLg_2_wZTQ)
[![MIT](https://badgen.net/badge/license/MIT/3da639)](LICENSE)

</div>


## Introduction

### What is instantbox?

It's a project that spins up temporary Linux systems with instant webshell access from any browser.


### What can an instantbox do?

1. provides a clean Linux environment for a presentation
2. let students experience the charm of Linux at your school or your next LUG meet
3. run with an inspiration in a clean environment
4. manage servers from any device
5. experiment with an open source project
6. test software performance under resource constraints

and more! ideas are endless...


### Which Linux distributions are available?

We currently supports various versions of Ubuntu, CentOS, Arch Linux, Debian, Fedora and Alpine.



## Quickstart

![Demo screenshot](https://user-images.githubusercontent.com/5880908/53613565-6237a500-3ba4-11e9-9e39-8ea48cee73ee.png)


## Deploy

Prerequisite: docker [[More Information]](https://docs.docker.com/install/)

```bash
mkdir instantbox && cd $_
bash <(curl -sSL https://raw.githubusercontent.com/instantbox/instantbox/master/init.sh)
```


## Questions

Please submit an issue or join the conversation on [telegram](https://t.me/joinchat/HtYtxRSerOwrMLg_2_wZTQ).


## Donations

We are in urgent need for donations in the form of server resources. Please contact us at team@instantbox.org if you are able to help. We appreciate it!


## Credits

* [tsl0922/ttyd](https://github.com/tsl0922/ttyd) - webshell


## License

[MIT](LICENSE)
