Skip to content

Commit

Permalink
links
Browse files Browse the repository at this point in the history
  • Loading branch information
rcarmo committed Apr 7, 2024
1 parent 60ea882 commit 456c502
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 13 deletions.
12 changes: 5 additions & 7 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,21 @@

**Q:** Why `piku`?

**A:** Partly because it's supposed to run on a [Pi][pi], because it's Japanese onomatopeia for 'twitch' or 'jolt', and because I know the name will annoy some of my friends.
**A:** Partly because it's started out on the [Raspberry Pi][pi], because it's Japanese onomatopeia for 'twitch' or 'jolt', and because we knew the name would be cute and amusing.

**Q:** Why Python/why not Go?

**A:** I actually thought about doing this in Go right off the bat, but [click][click] is so cool and I needed to have [uWSGI][uwsgi] running anyway, so I caved in. But I'm very likely to take something like [suture](https://github.com/thejerf/suture) and port this across, doing away with [uWSGI][uwsgi] altogether.
**A:** We actually thought about doing this in Go right off the bat, but [click][click] is so cool and we needed to have `uwsgi` running anyway, so we caved in. But possible future directions are likely to take something like [suture](https://github.com/thejerf/suture) and port this across (or just use [Caddy](http://caddyserver.com)), doing away with `uwsgi` altogether.

Go also (at the time) did not have a way to vendor dependencies that I was comfortable with, and that is also why Go support fell behind. Hopefully that will change soon.
Go also (at the time) did not have a way to vendor dependencies that we were comfortable with, and that is also why Go support fell behind. Hopefully that will change soon.

**Q:** Does it run under Python 3?

**A:** Right now, it _only_ runs on Python 3, even though it can deploy apps written in both major versions. It began its development using 2.7 and using`click` for abstracting the simpler stuff, and I eventually switched over to 3.5 once it was supported in Debian Stretch and Raspbian since I wanted to make installing it on the Raspberry Pi as simple as possible.
**A:** Right now, it _only_ runs on Python 3, even though it can deploy apps written in both major versions. It began its development using 2.7 and using`click` for abstracting the simpler stuff, and we eventually switched over to 3.5 once it was supported in Debian Stretch and Raspbian since we wanted to make installing it on the Raspberry Pi as simple as possible.

**Q:** Why not just use `dokku`?

**A:** I used `dokku` daily for most of my personal stuff for a good while. But it relied on a number of `x64` containers that needed to be completely rebuilt for ARM, and when I decided I needed something like this (March 2016) that was barely possible - `docker` itself was not fully baked for ARM yet, and people were at the time trying to get `herokuish` and `buildstep` to build on ARM.


**A:** We used `dokku` daily for many projects. But it relied on a number of `x64` containers that needed to be completely rebuilt for `ARM`, and when we decided we needed something like this (March 2016) that was barely possible - `docker` itself was not fully baked for `ARM` yet, and people were at the time just starting to get `herokuish` and `buildstep` to build on `ARM`.

[click]: http://click.pocoo.org
[pi]: http://www.raspberrypi.org
Expand Down
18 changes: 14 additions & 4 deletions docs/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,24 @@ worker.py
requirements.txt
```

### Configuration Files

`piku` relies on two configuration files shipped with your app to determine how to run it: [`Procfile`](procfile.md) and [`ENV`](env.md).
<p class="grid cards" markdown>
<a href="env.md" class="card">
:material-file-key: ENV
</a>
<a href="procfile.md" class="card">
:material-file-cog: Procfile
</a>
</p>

## Configuration Files

`piku` relies on two configuration files shipped with your app to determine how to run it: [`ENV`](env.md) and [`Procfile`](procfile.md).

* The [`Procfile`](procfile.md) tells `piku` what kind of workers to run
* The [`ENV`](env.md) file contains environment variables that allow you to configure both `piku` and your app, following the [12-factor app](https://12factor.net) approach.
* The [`Procfile`](procfile.md) tells `piku` what kind of workers to run

### Runtime Detection
## Runtime Detection

Besides [`ENV`](env.md) and [`Procfile`](procfile.md), `piku` also looks for runtime-specific files in the root of your app's directory:

Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
<a href="install/index.md" class="card">
:fontawesome-solid-download: Installing
</a>
<a href="install/index.md" class="card">
:material-gesture-tap-hold: Using
<a href="features.md" class="card">
:material-gesture-tap-hold: Using/Features
</a>
<a href="manage.md" class="card">
:octicons-tools-16: Managing
Expand Down

0 comments on commit 456c502

Please sign in to comment.