Nextcloud API 安装文档

备注

查看自动化 API 文档 。

API 参数

Nextcloud 安装参数

所有任务共享的参数

注意: 这些参数是所有任务共有的,添加之后请确保跟子参数没有冲突

type	object
properties
meta	系统参数
	default	skip_os_check	False
		enable_junit	False
		enable_debug	False
	allOf	系统参数
install_dir	安装目录
	Nextcloud 安装目录。最好为一个空文件夹(防止覆盖文件)，如果指定的文件夹不存在则会自动创建
	type	string
listen_port	监听端口
	nextcloud 监听端口
	type	integer
	default	8080
s3	S3 配置
	Nextcloud 的S3 存储配置
	default	s3_host	null
		s3_bucket	null
		s3_key	null
		s3_secret	null
		s3_port	null
		s3_ssl	null
		s3_region	null
		s3_usepath_style	null
	allOf	S3存储配置
swift	Swift 配置
	Nextcloud Swift 配置
	default	swift_url	null
		swift_autocreate	null
		swift_user_name	null
		swift_user_password	null
		swift_user_domain	null
		swift_project_name	null
		swift_project_domain	null
		swift_service_name	null
		swift_service_region	null
		swift_container_name	null
	allOf	Swift存储配置
db_use	数据库选择
	选择要使用的数据库(对于个人使用场景，建议使用 SQLite, 其他场景建议使用 PostgreSQL)
	type	string
	enum	SQLite, MySQL, PostgreSQL
	default	SQLite
sqlite	SQLite 数据库配置
	default	database	null
	allOf	SQLite 数据库配置
mysql	MySQL 数据库配置
	default	host	null
		root_password	322fd3ab2237828886d6c803
		database	mysql
		user	mysql
		password	44809839cd594369db53580e
	allOf	MySQL 配置
postgresql	PostgreSQL 数据库配置
	default	host	null
		password	302c9b654880936a
		username	postgres
		db_name	null
		init_args	null
	allOf	PostgreSQL 配置
redis	Redis 配置
	default	host	null
		host_port	6379
		host_password	be1e2b27900259fc026096c6
	allOf	Redis 配置
smtp	SMTP 配置
	default	host	null
		secure	null
		port	null
		authtype	null
		name	null
		password	null
		from_address	null
		domain	null
	allOf	SMTP 邮件配置
admin_user	Nextcloud 管理员账号
	Name of the Nextcloud admin user.
	type	string
admin_password	Nextcloud 管理员密码
	Password for the Nextcloud admin user.
	type	string
data_dir	Nextcloud 数据目录 [注意这个配置使用的是主机上的目录]
	(default: /var/www/html/data) Configures the data directory where nextcloud stores all files from the users.
	type	string
trusted_domains	信任域名
	默认没有设置(如果有多个，请使用 空格 分割)(not set by default) Optional space-separated list of domains
	type	string
update	UPDATE
	是否启用更新 默认:否(default: 0)
	type	string

系统参数

自动化任务系统内置参数,谨慎使用

type	object
properties
skip_os_check	跳过系统检测
	不进行操作系统的检测。如果您确信你的系统满足此任务的要求，并且您的系统不在已测试列表中，则选择此选项以跳过操作系统的检测.
	type	boolean
	default	False
enable_junit	启用JUnit
	启用Junit分析,此选项仅提供给开发者使用，用于分析问题[默认:关闭]
	type	boolean
	default	False
enable_debug	调试模式
	额外输出调试日志, 注意: 这仅仅在内部测试时使用
	type	boolean
	default	False

S3存储配置

type	object
properties
s3_host	S3 Host
	S3 对象存储服务器。[The hostname of the object storage server]
	type	string
s3_bucket	S3 Bucket
	S3 对象存储桶。[The name of the bucket that Nextcloud should store the data in]
	type	string
s3_key	S3 key
	S3 访问令牌。[AWS style access key]
	type	string
s3_secret	S3 secret
	S3 访问密钥[AWS style secret access key]
	type	string
s3_port	S3_PORT
	The port that the object storage server is being served over
	type	string
s3_ssl	S3_SSL
	(default: true): Whether or not SSL/TLS should be used to communicate with object storage server
	type	string
s3_region	S3_REGION
	The region that the S3 bucket resides in.
	type	string
s3_usepath_style	S3_USEPATH_STYLE
	(default: false): Not required for AWS S3
	type	string

Swift存储配置

type	object
properties
swift_url	SWIFT_URL
	The Swift identity (Keystone) endpoint
	type	string
swift_autocreate	SWIFT_AUTOCREATE
	(default: false): Whether or not Nextcloud should automatically create the Swift container
	type	string
swift_user_name	SWIFT_USER_NAME
	Swift username
	type	string
swift_user_password	SWIFT_USER_PASSWORD
	Swift user password
	type	string
swift_user_domain	SWIFT_USER_DOMAIN
	(default: Default): Swift user domain
	type	string
swift_project_name	SWIFT_PROJECT_NAME
	OpenStack project name
	type	string
swift_project_domain	SWIFT_PROJECT_DOMAIN
	(default: Default): OpenStack project domain
	type	string
swift_service_name	SWIFT_SERVICE_NAME
	(default: swift): Swift service name
	type	string
swift_service_region	SWIFT_SERVICE_REGION
	Swift endpoint region
	type	string
swift_container_name	SWIFT_CONTAINER_NAME
	Swift container (bucket) that Nextcloud should store the data in
	type	string

SQLite 数据库配置

type	object
properties
database	SQLite 数据库
	SQLite 数据库的名称(数据保存在 安装目录 /html/data/下面) Name of the database using sqlite
	type	string

MySQL 配置

Docker MySQL 配置

文档: https://hub.docker.com/_/mysql

type	object
properties
host	MySQL 服务器
	Hostname of the database server using mysql / mariadb.
	type	string
root_password	MySQL Root 密码
	This variable is mandatory and specifies the password that will be set for the MySQL root superuser account. In the above example, it was set to my-secret-pw.
	type	string
database	数据库名称
	This variable is optional and allows you to specify the name of a database to be created on image startup. If a user/password was supplied (see below) then that user will be granted superuser access (corresponding to GRANT ALL) to this database.
	type	string
	default	mysql
user	USER
	These variables are optional, used in conjunction to create a new user and to set that user’s password. This user will be granted superuser permissions (see above) for the database specified by the MYSQL_DATABASE variable. Both variables are required for a user to be created.
	type	string
	default	mysql
password	PASSWORD
	These variables are optional, used in conjunction to create a new user and to set that user’s password. This user will be granted superuser permissions (see above) for the database specified by the MYSQL_DATABASE variable. Both variables are required for a user to be created.
	type	string

PostgreSQL 配置

PostgreSQL Docker 环境变量设置

https://hub.docker.com/_/postgres

type	object
properties
host	PostgreSQL 服务器地址
	这个值具有特殊的作用 当您不设置此值的时候，会自动给您创建 PostgreSQL 数据库， 如果您设置了此值,则会使用您设置的外部数据库。
	type	string
password	PostgreSQL 管理员密码
	PostgreSQL 数据库管理员密码。 This environment variable is required for you to use the PostgreSQL image. It must not be empty or undefined. This environment variable sets the superuser password for PostgreSQL. The default superuser is defined by the POSTGRES_USER environment variable. Note 1: The PostgreSQL image sets up trust authentication locally so you may notice a password is not required when connecting from localhost (inside the same container). However, a password will be required if connecting from a different host/container. Note 2: This variable defines the superuser password in the PostgreSQL instance, as set by the initdb script during initial container startup. It has no effect on the PGPASSWORD environment variable that may be used by the psql client at runtime, as described at https://www.postgresql.org/docs/current/libpq-envars.html. PGPASSWORD, if used, will be specified as a separate environment variable.
	type	string
username	PostgreSQL 管理员账号
	This optional environment variable is used in conjunction with POSTGRES_PASSWORD to set a user and its password. This variable will create the specified user with superuser power and a database with the same name. If it is not specified, then the default user of postgres will be used. Be aware that if this parameter is specified, PostgreSQL will still show The files belonging to this database system will be owned by user “postgres” during initialization. This refers to the Linux system user (from /etc/passwd in the image) that the postgres daemon runs as, and as such is unrelated to the POSTGRES_USER option. See the section titled “Arbitrary –user Notes” for more details.
	type	string
	default	postgres
db_name	PostgreSQL 数据库名
	This optional environment variable can be used to define a different name for the default database that is created when the image is first started. If it is not specified, then the value of POSTGRES_USER will be used.
	type	string
init_args	数据库初始化参数
	This optional environment variable can be used to send arguments to postgres initdb. The value is a space separated string of arguments as postgres initdb would expect them. This is useful for adding functionality like data page checksums: -e POSTGRES_INITDB_ARGS=”–data-checksums”.
	type	string

Redis 配置

Docker Redis 配置

文档: https://hub.docker.com/_/redis

type	object
properties
host	Redis 服务器
	如果您配置此服务器，则使用您配置的，如果为空则会自动创建一个 Redis
	type	string
host_port	Redis 端口
	(default: 6379) Optional port for Redis, only use for external Redis servers that run on non-standard ports.
	type	string
	default	6379
host_password	Redis 密码
	(not set by default) Redis password
	type	string

SMTP 邮件配置

type	object
properties
host	HOST
	(not set by default): The hostname of the SMTP server.
	type	string
secure	SECURE
	(empty by default): Set to ssl to use SSL, or tls to use STARTTLS.
	type	string
port	PORT
	(default: 465 for SSL and 25 for non-secure connections): Optional port for the SMTP connection. Use 587 for an alternative port for STARTTLS.
	type	string
authtype	验证类型
	(default: LOGIN): The method used for authentication. Use PLAIN if no authentication is required.
	type	string
name	NAME
	(empty by default): The username for the authentication.
	type	string
password	PASSWORD
	(empty by default): The password for the authentication.
	type	string
from_address	FROM_ADDRESS
	(not set by default): Use this address for the ‘from’ field in the emails sent by Nextcloud.
	type	string
domain	DOMAIN
	(not set by default): Set a different domain for the emails than the domain where Nextcloud is installed.
	type	string