Documentation
¶
Overview ¶
Package cmd implements commands for running pydio services
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( IsFork bool EnvPrefixOld = "pydio" EnvPrefixNew = "cells" )
var ( FilterStartTags []string FilterStartExclude []string )
var AclCmd = &cobra.Command{ Use: "acl", Short: "Manage access control lists", Long: ` DESCRIPTION ACLs are managed in a dedicated microservice. It is simpler to manage them in the frontend, but you can use this command to create/delete/search ACLs directly. ACLs are used to grant permissions to a given node Uuid for a given Role. `, Run: func(cmd *cobra.Command, args []string) { cmd.Help() }, }
AclCmd represents the acl command
var AdminCmd = &cobra.Command{ Use: "admin", Short: "Direct Read/Write access to Cells data", Long: ` DESCRIPTION Set of commands with direct access to Cells data. These commands require a running Cells instance. They connect directly to low-level services using gRPC connections. They are not authenticated. `, PersistentPreRunE: func(cmd *cobra.Command, args []string) error { bindViperFlags(cmd.Flags(), map[string]string{}) viper.SetDefault("registry", "grpc://:8000") viper.SetDefault("broker", "grpc://:8003") handleRegistry() handleBroker() handleTransport() return nil }, Run: func(cmd *cobra.Command, args []string) { cmd.Help() }, }
AdminCmd groups the data manipulation commands The sub-commands are connecting via gRPC to a **running** Cells instance.
var CleanCmd = &cobra.Command{ Use: "clean", PersistentPreRun: func(cmd *cobra.Command, args []string) { bindViperFlags(cmd.Flags(), map[string]string{}) viper.SetDefault("registry", "grpc://:8000") viper.SetDefault("broker", "grpc://:8003") handleRegistry() handleBroker() handleTransport() initConfig() }, Run: func(cmd *cobra.Command, args []string) { cmd.Help() }, Short: "Housekeeping commands", Long: "Collection of tools for purging Cells internal data (activities, logs, etc)", }
var ClusterCmd = &cobra.Command{ Use: "cluster", Short: "Cluster management operations", Long: ` DESCRIPTION Set of commands for configuring a cluster node. `, PersistentPreRunE: func(cmd *cobra.Command, args []string) error { initLogLevel() return nil }, Run: func(cmd *cobra.Command, args []string) { cmd.Help() }, }
Cluster groups the cluster management operations The sub-commands are changing the configuration of the cluster registry.
var ConfigCmd = &cobra.Command{ Use: "config", Short: "Configuration manager", Long: ` DESCRIPTION Set of commands providing programmatic access to stored configuration `, PersistentPreRun: func(cmd *cobra.Command, args []string) { bindViperFlags(cmd.Flags(), map[string]string{}) viper.SetDefault("registry", "grpc://:8000") viper.SetDefault("broker", "grpc://:8003") handleRegistry() initConfig() }, Run: func(cmd *cobra.Command, args []string) { cmd.Help() }, }
ConfigCmd represents the config command
var ConfigureCmd = &cobra.Command{ Use: "configure", Aliases: []string{"install"}, Short: "Setup required configurations", Long: ` DESCRIPTION Launch the configuration process of Pydio Cells. REQUIREMENTS You must have an available MySQL database, along with a privileged user (for instance 'pydio'). Supported databases are: - MariaDB version 10.3 and above, - MySQL version 5.7 and above (except 8.0.22 that has a bug preventing Cells to run correctly). As recommended by database documentation, tune the 'max_connections' parameter to a value in line with your production database server specifications. For reference, the default value of 151 will have a maximum memory usage of about 575MB, but will not scale up for a multiple users load in production. BROWSER-BASED INSTALLER If you are on a desktop machine, pick browser-based installation at first prompt, or you can force it with: $ ` + os.Args[0] + ` configure --bind default The installer opens a web page on port 8080 with a wizard for you to provide various configuration parameters, including DB connection info and the login/password of the main administrator. In case where default port is busy, you can choose another one via the 'bind' flag, for instance: $ ` + os.Args[0] + ` configure --bind 0.0.0.0:12345 or $ ` + os.Args[0] + ` configure --bind <your server IP or FQDN>:12345 After browser configuration, all microservices 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. COMMAND-LINE INSTALLER If you are more a shell person, you can perform the configuration process directly using this CLI (using the '--cli' flag or by choosing so at first prompt). You will then be able to choose to either use the default bindings for the embedded webserver or adapt these to your specific setup. You can always reconfigure the webserver bindings afterwards by calling this command: $ ` + os.Args[0] + ` configure sites See corresponding inline documentation for further details. AUTOMATED PROVISIONING For automated, non-interactive installation, you can pass a YAML or a JSON config file that contains all necessary information, please refer to the documentation on https://pydio.com ENVIRONMENT All the command flags documented below are mapped to their associated ENV var using upper case and CELLS_ prefix. For example : $ ` + os.Args[0] + ` configure --bind :9876 is equivalent to $ export CELLS_BIND=":9876"; ` + os.Args[0] + ` configure For backward compatibility reasons, the --cli, --yaml and --json flags do not respect the above rule (this might evolve in the 3.x version). They are respectively equivalent to CELLS_INSTALL_CLI, CELLS_INSTALL_YAML and CELLS_INSTALL_JSON ENV vars. `, PreRunE: func(cmd *cobra.Command, args []string) error { if err := checkFdlimit(); err != nil { return err } initConfig() replaceKeys := map[string]string{ "yaml": "install_yaml", "json": "install_json", "cli": "install_cli", } cmd.Flags().VisitAll(func(flag *pflag.Flag) { key := flag.Name if replace, ok := replaceKeys[flag.Name]; ok { key = replace } viper.BindPFlag(key, flag) }) 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 access and credentials to a MySQL 5.6+ (or MariaDB equivalent) server.") cmd.Println("Pick your installation mode when you are ready.") cmd.Println("") var proxyConf *install.ProxyConfig var err error 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 != "" { return } proxyConf = installConf.GetProxyConfig() } else { if !niModeCli { 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 } sites, err := config.LoadSites() fatalIfError(cmd, err) proxyConf = sites[0] proxyConf, err = switchDefaultTls(cmd, proxyConf, niNoTls) fatalIfError(cmd, err) if !niModeCli { var message string proxyConf, message, err = checkDefaultBusy(cmd, proxyConf, true) fatalIfError(cmd, err) if message != "" { cmd.Println(promptui.IconWarn, message) } } } if niModeCli { _, err := cliInstall(cmd, proxyConf) fatalIfError(cmd, err) } else { performBrowserInstall(cmd, proxyConf) } if niExitAfterInstall || (niModeCli && cmd.Name() != "start") { cmd.Println("") cmd.Println(promptui.IconGood + "\033[1m Installation Finished\033[0m") cmd.Println("") return } select { case <-cmd.Context().Done(): return default: if DefaultStartCmd.PreRunE != nil { if err := DefaultStartCmd.PreRunE(cmd, args); err != nil { return } } else if DefaultStartCmd.PreRun != nil { DefaultStartCmd.PreRun(cmd, args) } if DefaultStartCmd.RunE != nil { if err := DefaultStartCmd.RunE(cmd, args); err != nil { return } } else if DefaultStartCmd.Run != nil { DefaultStartCmd.Run(cmd, args) } if DefaultStartCmd.PostRunE != nil { if err := DefaultStartCmd.PostRunE(cmd, args); err != nil { return } } else if DefaultStartCmd.PostRun != nil { DefaultStartCmd.PostRun(cmd, args) } } }, }
ConfigureCmd launches a wizard (either in this CLI or in your web browser) to configure a new instance of Pydio Cells.
var DataCmd = &cobra.Command{ Use: "data", Hidden: true, Short: "Directly interact with a datasource", Long: ` DESCRIPTION Set of commands to manage indexed data. Data are indexed in the various data sources you may have defined, and aggregated into a unique tree by the tree service. This command allows you among others to launch a full re-synchronisation of a given datasource. `, Run: func(cmd *cobra.Command, args []string) { cmd.Help() }, }
DataCmd is kept hidden for backward compatibility
var DataSourceCmd = &cobra.Command{ Use: "datasource", PersistentPreRun: func(cmd *cobra.Command, args []string) { bindViperFlags(cmd.Flags(), map[string]string{}) viper.SetDefault("registry", "grpc://:8000") viper.SetDefault("broker", "grpc://:8003") handleRegistry() handleBroker() handleTransport() initConfig() }, Run: func(cmd *cobra.Command, args []string) { cmd.Help() }, Short: "Datasource management commands", Long: "Collection of tools for manipulating datasources", }
var (
DefaultStartCmd *cobra.Command
)
var DocCmd = &cobra.Command{ Use: "doc", Hidden: true, Short: "Manage documentation about Cells and this CLI tool", Long: ``, Run: func(cmd *cobra.Command, args []string) { cmd.Help() }, }
var FilesCmd = &cobra.Command{ Use: "files", Short: "Directly manage files and metadata on the nodes", Long: ` DESCRIPTION Manage metadata linked to nodes. Metadata are stored as simple key/values and attached to a node UUID. `, Run: func(cmd *cobra.Command, args []string) { cmd.Help() }, }
var RootCmd = &cobra.Command{ Use: os.Args[0], Short: "Secure File Sharing for business", Long: ` DESCRIPTION Pydio Cells is self-hosted Document Sharing & Collaboration software for organizations that need advanced sharing without security trade-offs. Cells gives you full control of your document sharing environment – combining fast performance, huge file transfer sizes, granular security, and advanced workflow automations in an easy-to-set-up and easy-to-support self-hosted platform. CONFIGURE For the very first run, use '` + os.Args[0] + ` configure' to begin the browser-based or command-line based installation wizard. Services will automatically start at the end of a browser-based installation. RUN Run '$ ` + os.Args[0] + ` start' to load all services. WORKING DIRECTORIES By default, application data is stored under the standard OS application dir: - Linux: ${USER_HOME}/.config/pydio/cells - Darwin: ${USER_HOME}/Library/Application Support/Pydio/cells - Windows: ${USER_HOME}/ApplicationData/Roaming/Pydio/cells You can customize the storage locations with the following ENV variables: - CELLS_WORKING_DIR: replace the whole standard application dir - CELLS_DATA_DIR: replace the location for storing default datasources (default CELLS_WORKING_DIR/data) - CELLS_LOG_DIR: replace the location for storing logs (default CELLS_WORKING_DIR/logs) - CELLS_SERVICES_DIR: replace location for services-specific data (default CELLS_WORKING_DIR/services) LOGS LEVEL By default, logs are outputted in console format at the Info level and appended to a CELLS_LOG_DIR/pydio.log file. You can: - Change the level (debug, info, warn or error) with the --log flag or the CELLS_LOGS_LEVEL environment variable - Output the logs in json format with --log_json=true - Prevent logs from being written to a file with --log_to_file=false For backward compatibility, --log=production still works and is equivalent to "--log=info --log_json=true --log_to_file=true" `, PersistentPreRun: func(cmd *cobra.Command, args []string) { if cmd.Long == StartCmd.Long { common.LogCaptureStdOut = true } for _, skip := range infoCommands { if cmd.Name() == skip { return } } }, Run: func(cmd *cobra.Command, args []string) { cmd.Help() }, }
RootCmd represents the base command when called without any subcommands
var StartCmd = &cobra.Command{ Use: "start", Short: "Start one or more services", Long: ` DESCRIPTION Start one or more services on this machine. $ ` + os.Args[0] + ` start [flags] args... No arguments will start all services available (see 'ps' command). - Select specific services with regular expressions in the additional arguments. - The -t/--tags flag may limit to only a certain category of services (see usage below) - The -x/--exclude flag may exclude one or more services All these may be used in conjunction (-t, -x, regexp arguments). REQUIREMENTS Ulimit: set a number of allowed open files greater or equal to 2048. For production use, a minimum of 8192 is recommended (see ulimit -n). Setcap: if you intend to bind the server to standard http ports (80, 443), you must grant necessary permissions on cells binary with this command: $ sudo setcap 'cap_net_bind_service=+ep' <path to your binary> EXAMPLES 1. Start all Cells services $ ` + os.Args[0] + ` start 2. Start all services whose name starts with pydio.grpc $ ` + os.Args[0] + ` start pydio.grpc 3. Start only services for scheduler $ ` + os.Args[0] + ` start --tag=scheduler 4. Start whole plateform except the roles service $ ` + os.Args[0] + ` start --exclude=pydio.grpc.idm.role ENVIRONMENT 1. Flag mapping All the command flags documented below are mapped to their associated ENV var, using upper case and CELLS_ prefix. For example : $ ` + os.Args[0] + ` start --grpc_external 54545 is equivalent to $ export CELLS_GRPC_EXTERNAL=54545; ` + os.Args[0] + ` start [Note]: the only exception is the --log flag, that is mapped to CELLS_LOGS_LEVEL instead. 2. Working Directories - CELLS_WORKING_DIR: replace the whole standard application dir - CELLS_DATA_DIR: replace the location for storing default datasources (default CELLS_WORKING_DIR/data) - CELLS_LOG_DIR: replace the location for storing logs (default CELLS_WORKING_DIR/logs) - CELLS_SERVICES_DIR: replace location for services-specific data (default CELLS_WORKING_DIR/services) 3. Timeouts, limits, proxies - CELLS_SQL_DEFAULT_CONN, CELLS_SQL_LONG_CONN: timeouts used for SQL queries. Use a golang duration (10s, 1m, etc). Defaults are respectively 30 seconds and 10 minutes. - CELLS_CACHES_HARD_LIMIT: maximum memory limit used by internal caches (in MB, default is 8). This is a per/cache limit, not global. - CELLS_UPDATE_HTTP_PROXY: if your server uses a client proxy to access outside world, this can be set to query update server. - HTTP_PROXY, HTTPS_PROXY, NO_PROXY: golang-specific environment variables to configure a client proxy for all external http calls. 4. Development variables - CELLS_ENABLE_WIP_LANGUAGES: show partially translated languages in the UX language picker. - CELLS_ENABLE_LIVEKIT: enable experimental support for video calls in the chat window, using a livekit-server. - CELLS_ENABLE_FORMS_DEVEL: display a basic UX form with all possible fields types in the UX (for React developers) `, PreRunE: func(cmd *cobra.Command, args []string) error { if !IsFork { if err := checkFdlimit(); err != nil { return err } if dc := os.Getenv("CELLS_SQL_DEFAULT_CONN"); dc != "" { if ddc, e := time.ParseDuration(dc); e == nil { fmt.Println("[ENV] Overriding DefaultConnectionTimeout with env value", ddc) } } if dc := os.Getenv("CELLS_SQL_LONG_CONN"); dc != "" { if ddc, e := time.ParseDuration(dc); e == nil { fmt.Println("[ENV] Overriding LongConnectionTimeout with env value", ddc) } } } bindViperFlags(cmd.Flags(), map[string]string{ "log": "logs_level", "fork": "is_fork", }) if !config.RuntimeIsRemote() { if !filex.Exists(filepath.Join(config.PydioConfigDir, config.PydioConfigFile)) { return triggerInstall( "We cannot find a configuration file ... "+config.ApplicationWorkingDir()+"/pydio.json", "Do you want to create one now", cmd, args) } if initConfig() { return triggerInstall( "Oops, the configuration is not right ... "+config.ApplicationWorkingDir()+"/pydio.json", "Do you want to reset the initial configuration", cmd, args) } } initStartingToolsOnce.Do(func() { initLogLevel() metrics.Init() handleRegistry() handleBroker() handleTransport() handleSignals() }) if config.RuntimeIsRemote() { initConfig() } if v := config.Get("version").String(); v == "" { return triggerInstall( "Oops, the configuration is not right ... "+config.ApplicationWorkingDir()+"/pydio.json", "Do you want to reset the initial configuration", cmd, args) } plugins.Init(cmd.Context(), "main") registry.Default.Filter(func(s registry.Service) bool { for _, exclude := range FilterStartExclude { re := regexp.MustCompile(exclude) if strings.HasPrefix(s.Name(), exclude) || re.MatchString(s.Name()) { return true } } return false }) registry.Default.Filter(func(s registry.Service) bool { for _, exclude := range FilterStartExclude { if exclude == startTagUnique && s.MustBeUnique() { return true } } for _, t := range FilterStartTags { if t == startTagUnique && s.MustBeUnique() { registry.ProcessStartTags = append(registry.ProcessStartTags, "t:"+t) return false } else { for _, st := range s.Tags() { if t == st { registry.ProcessStartTags = append(registry.ProcessStartTags, "t:"+t) return false } } } } return len(FilterStartTags) > 0 }) registry.Default.Filter(func(s registry.Service) bool { for _, arg := range args { reArg := regexp.MustCompile(arg) if reArg.MatchString(s.Name()) { registry.ProcessStartTags = append(registry.ProcessStartTags, "s:"+s.Name()) return false } if s.MatchesRegexp(arg) { registry.ProcessStartTags = append(registry.ProcessStartTags, "s:"+s.Name()) return false } } return len(args) > 0 }) registry.Default.Filter(func(s registry.Service) bool { if len(args) == 0 && s.Regexp() != nil { return true } return false }) for _, x := range FilterStartExclude { registry.ProcessStartTags = append(registry.ProcessStartTags, "x:"+x) } if s, err := registry.Default.ListServices(); err != nil { return fmt.Errorf("Could not retrieve list of services") } else { allServices = s } if replaced := config.EnvOverrideDefaultBind(); replaced { if ss, e := config.LoadSites(true); e == nil && len(ss) > 0 && !IsFork { fmt.Println("*****************************************************************") fmt.Println("* Dynamic bind flag detected, overriding any configured sites *") fmt.Println("*****************************************************************") } } initServices() return nil }, RunE: func(cmd *cobra.Command, args []string) error { for _, service := range allServices { if !IsFork && service.RequiresFork() { if !service.AutoStart() { continue } go service.ForkStart(cmd.Context()) } else { go service.Start(cmd.Context()) } select { case <-microregistry.DefaultRegistry.Options().Context.Done(): return nil case <-cmd.Context().Done(): return nil default: continue } } for { select { case <-microregistry.DefaultRegistry.Options().Context.Done(): return nil case <-cmd.Context().Done(): return nil } } }, PostRunE: func(cmd *cobra.Command, args []string) error { reg := registry.GetCurrentProcess() if reg == nil { return nil } loop: for { select { case <-time.After(30 * time.Second): break loop default: if reg != nil && len(reg.Services) > 0 { time.Sleep(1 * time.Second) continue } break loop } } return nil }, }
StartCmd represents the start command
var ToolsCmd = &cobra.Command{ Use: "tools", Short: "Additional tools", Long: ` DESCRIPTION Various commands that do not require a running Cells instance. `, PersistentPreRun: func(cmd *cobra.Command, args []string) { initConfig() }, Run: func(cmd *cobra.Command, args []string) { cmd.Help() }, }
ToolsCmd are tools that do not need a running Cells instance
Functions ¶
func Execute ¶
func Execute()
Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.
func GenerateRandomBytes ¶
GenerateRandomBytes returns securely generated random bytes. It will return an error if the system's secure random number generator fails to function correctly, in which case the caller should not continue.
func RegisterAdditionalPrompt ¶
func RegisterAdditionalPrompt(step CellsCliPromptStep)
Types ¶
type CellsCliPromptStep ¶
type CellsCliPromptStep struct { Step string Prompt func(*install.InstallConfig) error }
type CellsVersion ¶
type CellsVersion struct { //Distribution string PackageLabel string Version string BuildTime string GitCommit string OS string Arch string GoVersion string }
CellsVersion contains version information for the current running binary
type NiInstallConfig ¶
type NiInstallConfig struct { install.InstallConfig `yaml:",inline"` ProxyConfigs []*install.ProxyConfig `json:"proxyConfigs" yaml:"proxyconfigs"` CustomConfigs map[string]interface{} `json:"customConfigs" yaml:"customconfigs"` }
Source Files
¶
- admin-acl-create.go
- admin-acl-delete.go
- admin-acl-patch-recycle-personal.go
- admin-acl-search.go
- admin-acl.go
- admin-clean-activities.go
- admin-clean-logs.go
- admin-clean.go
- admin-config-del.go
- admin-config-history.go
- admin-config-list.go
- admin-config-set.go
- admin-config.go
- admin-datasource-migrate.go
- admin-datasource-resync.go
- admin-datasource-snapshot.go
- admin-datasource.go
- admin-files-bench-create.go
- admin-files-ls.go
- admin-files-meta-put.go
- admin-files-meta-read.go
- admin-files.go
- admin-hidden-caddy.go
- admin-hidden-reload-assets.go
- admin-purge-activities.go
- admin-resync.go
- admin-user-create.go
- admin-user-delete.go
- admin-user-personal-token.go
- admin-user-search.go
- admin-user-set-profile.go
- admin-user-set-pwd.go
- admin-user-unlock.go
- admin-user.go
- admin.go
- cluster-start.go
- cluster.go
- compat-data-sync.go
- compat-data.go
- configure-database-add.go
- configure-database-list.go
- configure-database-set.go
- configure-database.go
- configure-sites-add.go
- configure-sites-delete.go
- configure-sites.go
- configure.go
- flag-nats.go
- flag-registry.go
- hidden-bench.go
- hidden-doc-deps.go
- hidden-doc-generate.go
- hidden-doc-i18n-count.go
- hidden-doc-i18n.go
- hidden-doc-openapi.go
- hidden-doc.go
- install-cli.go
- install-ni.go
- ps.go
- rlimit_posix.go
- root.go
- signals.go
- start.go
- tools-completion.go
- tools-config.go
- tools.go
- update.go
- version.go