forked from pydio/cells
-
Notifications
You must be signed in to change notification settings - Fork 0
/
install.go
460 lines (387 loc) · 13.9 KB
/
install.go
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
/*
* Copyright (c) 2018. Abstrium SAS <team (at) pydio.com>
* This file is part of Pydio Cells.
*
* Pydio Cells is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Pydio Cells is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with Pydio Cells. If not, see <http://www.gnu.org/licenses/>.
*
* The latest code can be found at <https://pydio.com>.
*/
package cmd
import (
"bytes"
"fmt"
"os"
"os/exec"
"path/filepath"
"runtime"
"strings"
"time"
"github.com/spf13/pflag"
"github.com/spf13/viper"
"github.com/manifoldco/promptui"
_ "github.com/mholt/caddy/caddyhttp"
"github.com/micro/go-micro/broker"
"github.com/spf13/cobra"
"github.com/pydio/cells/common"
"github.com/pydio/cells/common/caddy"
"github.com/pydio/cells/common/config"
"github.com/pydio/cells/common/plugins"
"github.com/pydio/cells/common/proto/install"
"github.com/pydio/cells/common/registry"
"github.com/pydio/cells/common/utils/net"
"github.com/pydio/cells/discovery/install/assets"
)
const (
caddyfile = `
{{range .Sites}}
{{range .Binds}}{{.}} {{end}}{
root "{{$.WebRoot}}"
proxy /install {{urls $.Micro}}
{{if .TLS}}tls {{.TLS}}{{end}}
{{if .TLSCert}}tls "{{.TLSCert}}" "{{.TLSKey}}"{{end}}
}
{{end}}
`
)
var (
caddyconf = struct {
Sites []caddy.SiteConf
WebRoot string
Micro string
}{}
niBindUrl string
niExtUrl string
niNoTls bool
niModeCli bool
niCertFile string
niKeyFile string
niLeEmailContact string
niLeAcceptEula bool
niLeUseStagingCA bool
niYamlFile string
niJsonFile string
niExitAfterInstall bool
)
var installCmd = &cobra.Command{
Use: "install",
Short: "Launch the installation process",
Long: `
This command launches the installation process of Pydio Cells.
Be ready to answer a few questions to configure the network connection of your application:
1. Bind URL: the name (or IP) and port to hook the internal webserver on a the network interface
2. TLS Settings: choose the TLS configuration that is exposed by this internal webserver
3. External URL: the URL you communicate to your end-users. It can differ from your bind address,
typically if the app is behind a proxy or inside a container with ports mapping.
You can also provide these connection parameters via flags to configure the main gateway
and directly launch the browser install.
Typically, define only --bind and --external flags to launch in default self-signed mode:
it generates locally trusted certificate with mkcert.
If you are working locally, the installer opens a browser (if you are installing on a remote server, copy/paste the URL),
to gather necessary extra information to finalize Pydio Cells installation.
Upon installation termination, all micro-services are started automatically and you can directly start using Cells.
It is yet good practice to stop the installer and restart cells in normal mode before going live.
If you do not have a browser access, you can also perform the whole installation process using this CLI.
See additional flags for more details or use another TLS mode, like in the following example that uses Let's Encrypt automatic certificate generation.
$ ` + os.Args[0] + ` install --bind share.mydomain.tld:443 --external https://share.mydomain.tld --le_email admin@mydomain.tld --le_agree true
Here is a list with a few examples of valid URL couples:
- Bind Host: 0.0.0.0:8080
- External Host: https://share.mydomain.tld
Or
- Bind Host: share.mydomain.tld:443
- External Host: https://share.mydomain.tld
Or
- Bind Host: IP:1515 # internal port
- External Host: https://IP:8080 # external port mapped by docker
Or
- Bind Host: localhost:8080
- External Host: http://localhost:8080 # Non-secured local installation
`,
PreRunE: func(cmd *cobra.Command, args []string) error {
if err := checkFdlimit(); err != nil {
return err
}
plugins.InstallInit(cmd.Context())
initServices()
// Manually bind to viper instead of flags.StringVar, flags.BoolVar, etc
niBindUrl = viper.GetString("bind")
niExtUrl = viper.GetString("external")
niNoTls = viper.GetBool("no_tls")
niModeCli = viper.GetBool("install_cli")
niCertFile = viper.GetString("tls_cert_file")
niKeyFile = viper.GetString("tls_key_file")
niLeEmailContact = viper.GetString("le_email")
niLeAcceptEula = viper.GetBool("le_agree")
niLeUseStagingCA = viper.GetBool("le_staging")
niYamlFile = viper.GetString("install_yaml")
niJsonFile = viper.GetString("install_json")
niExitAfterInstall = viper.GetBool("exit_after_install")
return nil
},
Run: func(cmd *cobra.Command, args []string) {
cmd.Println("")
cmd.Println("\033[1mWelcome to " + common.PackageLabel + " installation\033[0m ")
cmd.Println(common.PackageLabel + " (v" + common.Version().String() + ") will be configured to run on this machine.")
cmd.Println("Make sure to prepare the following data:")
cmd.Println(" - IPs and ports for binding the webserver to outside world")
cmd.Println(" - MySQL 5.6+ (or MariaDB equivalent) server access")
cmd.Println("Pick your installation mode when you are ready.")
cmd.Println("")
var proxyConf *install.ProxyConfig
var err error
// Do this in a better way
micro := config.Get("ports", common.ServiceMicroApi).Int()
if micro == 0 {
micro = net.GetAvailablePort()
config.Set(micro, "ports", common.ServiceMicroApi)
err = config.Save("cli", "Install / Setting default Ports")
fatalIfError(cmd, err)
}
if niYamlFile != "" || niJsonFile != "" || niBindUrl != "" {
installConf, err := nonInteractiveInstall(cmd, args)
fatalIfError(cmd, err)
if installConf.FrontendLogin != "" {
// We assume we have completely configured Cells. Exit.
return
}
// we only non-interactively configured the proxy, launching browser install
proxyConf = installConf.GetProxyConfig()
} else {
if !niModeCli {
// Ask user to choose between browser or CLI interactive install
p := promptui.Select{Label: "Installation mode", Items: []string{"Browser-based (requires a browser access)", "Command line (performed in this terminal)"}}
installIndex, _, err := p.Run()
fatalIfError(cmd, err)
niModeCli = installIndex == 1
}
// Gather proxy information
sites, err := config.LoadSites()
fatalIfError(cmd, err)
proxyConf = sites[0]
if proxyConf == config.DefaultBindingSite && niNoTls {
// Create a siteConf without TLS
noTlsConf := *proxyConf
noTlsConf.TLSConfig = nil
proxyConf = &noTlsConf
e := config.SaveSites([]*install.ProxyConfig{proxyConf}, common.PydioSystemUsername, "Create No TLS site at install")
fatalIfError(cmd, e)
}
fatalIfError(cmd, err)
// Prompt for config with CLI, apply and exit
if niModeCli {
_, err := cliInstall(proxyConf)
fatalIfError(cmd, err)
return
}
}
// Run browser install
performBrowserInstall(cmd, proxyConf)
if niExitAfterInstall {
cmd.Println("")
cmd.Println(promptui.IconGood + "\033[1m Installation Finished: installation server will stop\033[0m")
cmd.Println("")
return
}
cmd.Println("")
cmd.Println(promptui.IconGood + "\033[1m Installation Finished: server will restart\033[0m")
cmd.Println("")
plugins.Init(cmd.Context())
initServices()
// Re-building allServices list
if s, err := registry.Default.ListServices(); err != nil {
cmd.Print("Could not retrieve list of services")
os.Exit(0)
} else {
allServices = s
}
// Start all services
excludes := []string{
common.ServiceMicroApi,
common.ServiceRestNamespace_ + common.ServiceInstall,
}
for _, service := range allServices {
ignore := false
for _, ex := range excludes {
if service.Name() == ex {
ignore = true
}
}
if service.Regexp() != nil {
ignore = true
}
if !ignore {
if service.RequiresFork() {
if !service.AutoStart() {
continue
}
go service.ForkStart(cmd.Context())
} else {
go service.Start(cmd.Context())
}
}
}
<-cmd.Context().Done()
},
}
func performBrowserInstall(cmd *cobra.Command, proxyConf *install.ProxyConfig) {
// Installing the JS data
dir, err := assets.GetAssets("../discovery/install/assets/src")
if err != nil {
dir = filepath.Join(config.ApplicationWorkingDir(), "static", "install")
if err, _, _ := assets.RestoreAssets(dir, assets.PydioInstallBox, nil); err != nil {
cmd.Println("Could not restore install package", err)
os.Exit(0)
}
}
// config.Save("cli", "Install / Setting default Port") cmd.Println("Got the assets, internal is ", internal.String())
// config.Save("cli", "Install / Saving final configs")
// cmd.Println("final configs saved")
// starting the micro service
micro := registry.Default.GetServiceByName(common.ServiceMicroApi)
micro.Start(cmd.Context())
// starting the installation REST service
regService := registry.Default.GetServiceByName(common.ServiceInstall)
// installServ := regService.(service.Service)
// Strip some flag to avoid panic on re-registering a flag twice
// flags := installServ.Options().Web.Options().Cmd.App().Flags
// var newFlags []cli.Flag
// for _, f := range flags {
// if f.GetName() == "register_ttl" || f.GetName() == "register_interval" {
// continue
// }
// newFlags = append(newFlags, f)
// }
// installServ.Options().Web.Options().Cmd.App().Flags = newFlags
// Starting service install
regService.Start(cmd.Context())
// Creating temporary caddy file
sites, err := config.LoadSites()
if err != nil {
cmd.Println("Could not start with fast restart:", err)
os.Exit(1)
}
var er error
caddyconf.Sites, er = caddy.SitesToCaddyConfigs(sites)
if er != nil {
cmd.Println("Could not convert sites to caddy confs", er)
}
caddyconf.WebRoot = dir
caddyconf.Micro = common.ServiceMicroApi
caddy.Enable(caddyfile, play)
restartDone, err := caddy.StartWithFastRestart()
if err != nil {
cmd.Println("Could not start with fast restart:", err)
os.Exit(1)
}
cmd.Println("")
cmd.Println(promptui.Styler(promptui.BGMagenta, promptui.FGWhite)("Installation Server is starting..."))
cmd.Println(promptui.Styler(promptui.BGMagenta, promptui.FGWhite)("Listening to: " + proxyConf.GetBinds()[0]))
cmd.Println("")
subscriber, err := broker.Subscribe(common.TopicProxyRestarted, func(p broker.Publication) error {
cmd.Println("")
cmd.Printf(promptui.Styler(promptui.BGMagenta, promptui.FGWhite)("Opening URL ") + promptui.Styler(promptui.BGMagenta, promptui.FGWhite, promptui.FGUnderline, promptui.FGBold)(proxyConf.GetDefaultBindURL()) + promptui.Styler(promptui.BGMagenta, promptui.FGWhite)(" in your browser. Please copy/paste it if the browser is not on the same machine."))
cmd.Println("")
if proxyConf.ReverseProxyURL != "" {
open(proxyConf.ReverseProxyURL)
} else {
open(proxyConf.GetDefaultBindURL())
}
return nil
})
if err != nil {
cmd.Print(err)
os.Exit(1)
}
instanceDone := make(chan struct{}, 1)
go func() {
<-restartDone
instance := caddy.GetInstance()
instance.Wait()
instanceDone <- struct{}{}
}()
defer subscriber.Unsubscribe()
defer regService.Stop()
select {
case <-instanceDone:
return
case <-cmd.Context().Done():
os.Exit(0)
}
}
/* HELPERS */
func play(site ...caddy.SiteConf) (*bytes.Buffer, error) {
template := caddy.Get().GetTemplate()
buf := bytes.NewBuffer([]byte{})
if err := template.Execute(buf, caddyconf); err != nil {
return nil, err
}
return buf, nil
}
// open opens the specified URL in the default browser of the user.
func open(url string) error {
var cmd string
var args []string
switch runtime.GOOS {
case "windows":
cmd = "cmd"
args = []string{"/c", "start"}
case "darwin":
cmd = "open"
default: // "linux", "freebsd", "openbsd", "netbsd"
cmd = "xdg-open"
}
args = append(args, url)
return exec.Command(cmd, args...).Start()
}
func fatalIfError(cmd *cobra.Command, err error) {
if err != nil {
if err == promptui.ErrInterrupt {
fmt.Println(promptui.IconBad, "Operation aborted by user")
<-time.After(10 * time.Millisecond)
os.Exit(1)
}
fmt.Println(promptui.IconBad, "Unexpected error happened :", err.Error())
fmt.Printf("Use \"%s [command] --help\" for more information.", os.Args[0])
<-time.After(10 * time.Millisecond)
os.Exit(1)
}
}
func init() {
flags := installCmd.PersistentFlags()
flags.String("bind", "", "Internal URL:PORT on which the main proxy will bind. Self-signed SSL will be used by default")
flags.String("external", "", "External PROTOCOL:URL:PORT exposed to the outside")
flags.Bool("no_tls", false, "Configure the main gateway to rather use plain HTTP")
flags.Bool("cli", false, "Do not prompt for install mode, use CLI mode by default")
flags.String("tls_cert_file", "", "TLS cert file path")
flags.String("tls_key_file", "", "TLS key file path")
flags.String("le_email", "", "Contact e-mail for Let's Encrypt provided certificate")
flags.Bool("le_agree", false, "Accept Let's Encrypt EULA")
flags.Bool("le_staging", false, "Rather use staging CA entry point")
flags.String("yaml", "", "Points toward a configuration in YAML format")
flags.String("json", "", "Points toward a configuration in JSON format")
flags.Bool("exit_after_install", false, "Simply exits main process after the installation is done")
replaceKeys := map[string]string{
"yaml": "install_yaml",
"json": "install_json",
"cli": "install_cli",
}
flags.VisitAll(func(flag *pflag.Flag) {
key := flag.Name
if replace, ok := replaceKeys[flag.Name]; ok {
key = replace
}
flag.Usage += " [" + strings.ToUpper("$"+EnvPrefixNew+"_"+key) + "]"
viper.BindPFlag(key, flag)
})
RootCmd.AddCommand(installCmd)
}