mirror of
https://github.com/fnproject/fn.git
synced 2022-10-28 21:29:17 +03:00
daemon: add some basic godoc content (#289)
This commit is contained in:
25
doc.go
Normal file
25
doc.go
Normal file
@@ -0,0 +1,25 @@
|
||||
/*
|
||||
IronFunctions daemon
|
||||
|
||||
Refer to detailed documentation at https://github.com/iron-io/functions/tree/master/docs
|
||||
|
||||
Environment Variables:
|
||||
DB_URL
|
||||
The database URL to use in URL format. See [Databases](databases/README.md) for more information. Default: BoltDB in current working directory `bolt.db`.
|
||||
|
||||
MQ_URL
|
||||
The message queue to use in URL format. See [Message Queues](mqs/README.md) for more information. Default: BoltDB in current working directory `queue.db`.
|
||||
|
||||
API_URL
|
||||
The primary IronFunctions API URL to that this instance will talk to. In a production environment, this would be your load balancer URL.
|
||||
|
||||
PORT
|
||||
Sets the port to run on. Default: `8080`.
|
||||
|
||||
NUM_ASYNC
|
||||
The number of async runners in the functions process (default 1).
|
||||
|
||||
LOG_LEVEL
|
||||
Set to `DEBUG` to enable debugging. Default: INFO.
|
||||
*/
|
||||
package main
|
||||
Reference in New Issue
Block a user