Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ericwang401 committed Mar 26, 2022
1 parent dd197fc commit 8cc9eb2
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<h1 align="center"><img src="https://imgur.com/L8Ng6yw.png" width="400" alt="Logo"></h1>

> 😋 A beautiful server preview page for customers of hosting companies to view and test before buying
### ✨ Screenshot

![Screenshot](https://imgur.com/j9xpPJL.png)

## Install

If you have not already installed Docker, please install it from [Docker.com](https://docker.com)


🚨 WARNING: YOUR APP_KEY HAS TO INCLUDE UPPERCASE AND LOWERCASE LETTERS, NUMBERS, AND BE AT LEAST 15 CHARACTERS LONG. IF CONDITION NOT SATISFIED, SERVER WILL NOT START DUE TO SECURITY ERROR.

```sh
docker pull performave/pane:1.2

docker run -d --restart unless-stopped \
-p 80:80 \
-e HOST=0.0.0.0 \
-e PORT=80 \
-e APP_KEY=YOURKEY \
-e NODE_ENV=production \
-e NAME='YOURNAME' \
-e LOCATION='YOURLOCATION' \
-e IP_V4='YOURIP (CAN BE BLANK)' \
-e IP_V6='YOURIP (CAN BE BLANK)' \
performave/pane:1.2
```

## Author

👤 **Eric Wang**

* Website: https://performave.com
* Github: [@ericwang401](https://github.com/ericwang401)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/ericwang401/pane/issues).

## Show your support

Give a ⭐️ if this app helped you!
Please donate to [my Patreon](https://www.patreon.com/performave) to help let me keep working on these amazing open-source projects!

## 📝 License

Copyright © 2022 [Eric Wang](https://github.com/ericwang401).<br />
This project is [MIT](https://github.com/ericwang401/pane/blob/main/LICENSE) licensed.

0 comments on commit 8cc9eb2

Please sign in to comment.