mirror
/
piku
kopia lustrzana https://github.com/piku/piku
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Documentation improvements. (#122)

pull/131/head
Chris McCormick 2019-11-14 01:54:41 +08:00 zatwierdzone przez Rui Carmo
rodzic 69976bc7dc
commit 4046f9ac77
3 zmienionych plików z 15 dodań i 1 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

4
README.md
Wyświetl plik

@ -6,6 +6,8 @@ The tiniest Heroku/CloudFoundry-like PaaS you've ever seen.
[![asciicast](https://asciinema.org/a/Ar31IoTkzsZmWWvlJll6p7haS.svg)](https://asciinema.org/a/Ar31IoTkzsZmWWvlJll6p7haS) [![asciicast](https://asciinema.org/a/Ar31IoTkzsZmWWvlJll6p7haS.svg)](https://asciinema.org/a/Ar31IoTkzsZmWWvlJll6p7haS)
### Documentation: [Procfile](docs/DESIGN.md#procfile-format) | [ENV](./docs/ENV.md) | [Examples](./examples/README.md)
## Using `piku` ## Using `piku`
`piku` supports a Heroku-like workflow, like so: `piku` supports a Heroku-like workflow, like so:
@ -18,7 +20,7 @@ The tiniest Heroku/CloudFoundry-like PaaS you've ever seen.
* For Go, it defines a separate `GOPATH` for each app. * For Go, it defines a separate `GOPATH` for each app.
* For Node, it installs whatever is in `package.json` into `node_modules`. * For Node, it installs whatever is in `package.json` into `node_modules`.
* For Java, it builds your app depending on either `pom.xml` or `build.gradle` file. * For Java, it builds your app depending on either `pom.xml` or `build.gradle` file.
* It then looks at a `Procfile` and starts the relevant workers using [uWSGI][uwsgi] as a generic process manager. * It then looks at a [`Procfile` which is documented here](docs/DESIGN.md#procfile-format) and starts the relevant workers using [uWSGI][uwsgi] as a generic process manager.
* You can optionally also specify a `release` worker which is run once when the app is deployed. * You can optionally also specify a `release` worker which is run once when the app is deployed.
* You can then remotely change application settings (`config:set`) or scale up/down worker processes (`ps:scale`). * You can then remotely change application settings (`config:set`) or scale up/down worker processes (`ps:scale`).
* You can also bake application settings into a file called [`ENV` which is documented here](./docs/ENV.md). * You can also bake application settings into a file called [`ENV` which is documented here](./docs/ENV.md).

2
docs/DESIGN.md
Wyświetl plik

@ -52,6 +52,8 @@ SETTING2=${SETTING1}/bar
PORT=9080 PORT=9080
``` ```
See [ENV.md](./ENV.md) for a full list of Piku variables which can also be set.
Environment variables can be changed after deployment using `config:set`. Environment variables can be changed after deployment using `config:set`.
## Runtime detection ## Runtime detection

10
examples/README.md 100644
Wyświetl plik

@ -0,0 +1,10 @@
# Basic Piku application examples
* [Python WSGI app with background worker](https://github.com/piku/sample-python-app)
* [Python Django app](https://github.com/piku/sample-django-app)
* [Nodejs app](https://github.com/piku/sample-nodejs-app)
* [Python with Postgres database](./python-postgres)
* [Clojure app with Lein](https://github.com/piku/sample-clojure-app)
* [Node with Wisp](./nodejs-wisp)
* [Golang](./golang)