aboutsummaryrefslogtreecommitdiff
path: root/docs/man/appsluggr.1
blob: a0f3881ce2ff2e20d575660a8ebb4a778eefab5b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
.Dd December 09, 2018
.Dt APPSLUGGR 1 URM


.Sh NAME
.Nm appsluggr
.Nd appsluggr packages a precompiled binary application as a Heroku style slug for use with Dokku.


.Sh SYNOPSIS
.Nm

.Op Fl fname
.Op Fl license
.Op Fl web
.Op Fl web-scale
.Op Fl worker
.Op Fl worker-scale


.Sh DESCRIPTION
.Nm
is a small tool to package
.Li GOOS=linux GOARCH=amd64
binaries for consumption on
.Li hyperlink: http://dokku.viewdocs.io/dokku/ Dokku
.

.Bl -tag -width " " -offset indent -compact

.It Fl fname
The filename to write the resulting slug to.

The default value for this is
.Li slug.tar.gz
.

.It Fl license
If set, the tool will show its software license details and then exit.

.It Fl web
The path to the binary for the web process.

One of
.Fl web
or
.Fl worker
must be set.

.It Fl web-scale
The default scale for web process if defined.

The default value for this is 1.

.It Fl worker
The path to the binary for the worker process.
One of
.Fl web
or
.Fl worker
must be set.

.It Fl worker-scale
The default scale for the worker process if defined.

The default value for this is 1

.El


.Sh EXAMPLES

.Li appsluggr

.Li appsluggr -web web

.Li appsluggr -worker ilo-sona

.Li appsluggr -fname foo.tar.gz -web web -worker worker -web-scale 4 -worker-scale 16


.Sh IMPLEMENTATION NOTES

.Nm
when used with
.Lk hyperlink: http://dokku.viewdocs.io/dokku/ Dokku
requires the use of the
.Lk hyperlink: https://github.com/ryandotsmith/null-buildpack Null Buildpack
as follows:

.Li $ dokku config:set $APP_NAME BUILDPACK_URL=https://github.com/ryandotsmith/null-buildpack

Or

.Li $ ssh dokku@host config:set <see above>


.Sh DIAGNOSTICS

.Ex -std appsluggr


.Sh SEE ALSO

.Bl -bullet

.It
.Lk hyperlink: http://dokku.viewdocs.io/dokku/ Dokku

.It
.Lk hyperlink: https://github.com/ryandotsmith/null-buildpack Null Buildpack

.El