README
¶
Flynn is an open source Platform as a Service
- Website: https://flynn.io
- IRC: #flynn on Freenode
- Mailing list: flynn-users
Flynn is designed to run anything that can run on Linux, not just stateless web apps. Flynn includes built-in database appliances (just Postgres right now) and handles TCP traffic as well as HTTP and HTTPS.
Eventually we want Flynn to be the only tool developers and ops teams need to develop, deploy, and manage running software.
You can learn more about Flynn at our website.
The Flynn website also has documentation including FAQs.
Status
Flynn is very actively developed by Prime Directive, Inc. and the greater Flynn community.
Learn more about Flynn's stability.
Learn more about Flynn's security.
We want to know if you run into any unexpected behavior. Please report issues on this repository after searching to see if anyone has already reported the issue.
Getting Started
Run your own cluster
Flynn includes an installer that supports most major cloud providers.
If you want to setup and run your own Flynn cluster (either locally, on dedicated hardware or using a cloud provider) take a look at the Installation Guide.
Deploying applications
Check out the Using Flynn guide for instructions on deploying and scaling applications.
Contributing
We welcome and encourage community contributions to Flynn.
We have specific priorities for development. Pull requests that do not address these priorities may not be accepted.
Please familiarize yourself with the Contribution Guide before contributing.
There are many ways to help Flynn besides contributing code:
- Find bugs and file issues.
- Improve the documentation and website.
Learn more at flynn.io.
Contact us
We want to hear about any trouble, success, delight, or pain you experience when using Flynn. Let us know by filing an issue, joining the mailing list, joining us in IRC (#flynn on Freenode), or emailing us.
Flynn® is a trademark of Prime Directive, Inc.
Directories
¶
| Path | Synopsis |
|---|---|
|
appliance
|
|
|
mariadb/cmd/flynn-mariadb
command
|
|
|
mariadb/cmd/flynn-mariadb-api
command
|
|
|
mongodb/cmd/flynn-mongodb
command
|
|
|
mongodb/cmd/flynn-mongodb-api
command
|
|
|
postgresql
command
|
|
|
postgresql/api
command
|
|
|
redis/cmd/flynn-redis
command
|
|
|
redis/cmd/flynn-redis-api
command
|
|
|
cmd/flynn-blobstore-migrate
command
|
|
|
client
Package controller provides a client for each version of the controller API.
|
Package controller provides a client for each version of the controller API. |
|
client/v1
Package v1controller provides a client for v1 of the controller API.
|
Package v1controller provides a client for v1 of the controller API. |
|
examples
command
|
|
|
scheduler
command
|
|
|
worker
command
|
|
|
app
command
|
|
|
wrapper
command
|
|
|
gitreceive handles 'smart' Git HTTP requests for Flynn This HTTP server can service 'git clone', 'git push' etc.
|
gitreceive handles 'smart' Git HTTP requests for Flynn This HTTP server can service 'git clone', 'git push' etc. |
|
receiver
command
|
|
|
flynn-init
command
|
|
|
app
command
|
|
|
cmd/pinkerton
command
|
|
|
test
command
|
|
|
pkg
|
|
|
cluster
Package cluster implements a client for the Flynn host service.
|
Package cluster implements a client for the Flynn host service. |
|
cors
Package cors provides handlers to enable CORS support.
|
Package cors provides handlers to enable CORS support. |
|
keepalive
Package keepalive provides a listener that enables TCP keepalives.
|
Package keepalive provides a listener that enables TCP keepalives. |
|
mux
Package mux provides a multiplexer for net.Listener.
|
Package mux provides a multiplexer for net.Listener. |
|
pinned
Package pinned provides a dial function that checks TLS server certificates against local pins.
|
Package pinned provides a dial function that checks TLS server certificates against local pins. |
|
rpcplus
Package rpc provides access to the exported methods of an object across a network or other I/O connection.
|
Package rpc provides access to the exported methods of an object across a network or other I/O connection. |
|
rpcplus/fdrpc/_example
command
|
|
|
rpcplus/jsonrpc
Package jsonrpc implements a JSON-RPC ClientCodec and ServerCodec for the rpc package.
|
Package jsonrpc implements a JSON-RPC ClientCodec and ServerCodec for the rpc package. |
|
client
Package client provides a client for the router API.
|
Package client provides a client for the router API. |
|
example-generator
command
|
|
|
examples/client
command
|
|
|
examples/server
command
|
|
|
apps/echoer
command
|
|
|
apps/http
command
|
|
|
apps/ish
command
|
|
|
apps/partial-logger
command
|
|
|
apps/ping
command
|
|
|
apps/signal
command
|
|
|
runner
command
|
|
|
util/file-server
command
|
|
|
util
|
|
|
bump-buildpacks
command
|
|
|
dep_stub
command
|
|
|
release
command
|
|