103 lines
2.2 KiB
Markdown
103 lines
2.2 KiB
Markdown
# laurivan.outline
|
|
|
|
This role installs Outline via Docker.
|
|
|
|
## Requirements
|
|
|
|
None
|
|
|
|
## Role Variables
|
|
|
|
All variables are listed below (see also `defaults/main.yml`).
|
|
|
|
```yml
|
|
# defaults file for outline
|
|
|
|
outline_secret_key: 'changeme'
|
|
outline_utils_secret: 'changeme'
|
|
|
|
|
|
outline_setup_path: '~/outline'
|
|
outline_deployment: ''
|
|
|
|
outline_port: 3000
|
|
outline_url: "http://localhost:{{ outline_port }}"
|
|
outline_force_https: "false"
|
|
outline_enable_updates: "false"
|
|
outline_cdn_url:
|
|
|
|
outline_debug: "cache,presenters,events,emails,mailer,utils,multiplayer,server,services"
|
|
|
|
outline_volume_base: "/mnt/outline"
|
|
outline_volume_redis: "{{ outline_volume_base }}/redis"
|
|
outline_volume_db: "{{ outline_volume_base }}/db"
|
|
outline_volume_s3: "{{ outline_volume_base }}/s3"
|
|
|
|
oidc_client_id:
|
|
oidc_client_secret:
|
|
oidc_auth_uri:
|
|
oidc_token_uri:
|
|
oidc_userinfo_uri:
|
|
|
|
outline_google_client_id:
|
|
outline_google_client_secret:
|
|
outline_slack_client_id:
|
|
outline_slack_client_secret:
|
|
|
|
# If the db_host is not "postgres", then we assume the
|
|
# db is external and not spin up the docker container
|
|
outline_db_schema: "postgres"
|
|
outline_db_host: "postgres"
|
|
outline_db_port: "5432"
|
|
outline_db_user: "postgres"
|
|
outline_db_password: "changeme"
|
|
outline_db: "outline"
|
|
|
|
# By default, PostgreSQL is not secured. If you have a secure
|
|
# database instance, replace the content below with "enable".
|
|
outline_db_ssl: "disable"
|
|
|
|
# Spin up the fake S3 only if "fake_s3" is true
|
|
outline_fake_s3: true
|
|
outline_fake_s3_port: 4569
|
|
outline_aws_access_key_id:
|
|
outline_aws_secret_access_key:
|
|
outline_aws_region:
|
|
outline_aws_s3_upload_bucket_url: "http://s3:4569"
|
|
outline_aws_s3_upload_bucket_name: outline-bucket
|
|
outline_aws_s3_upload_max_size: "26214400"
|
|
outline_aws_s3_force_path_style: "true"
|
|
outline_aws_s3_acl: "private"
|
|
|
|
outline_smtp_host:
|
|
outline_smtp_port:
|
|
outline_smtp_username:
|
|
outline_smtp_password:
|
|
outline_smtp_from_email:
|
|
outline_smtp_reply_email:
|
|
|
|
outline_team_logo_url:
|
|
|
|
outline_language: 'en_US'
|
|
```
|
|
|
|
## Dependencies
|
|
|
|
You need a machine with docker and docker-compose installed.
|
|
|
|
## Example Playbook
|
|
|
|
```yml
|
|
- hosts: servers
|
|
roles:
|
|
- 'laurivan.outline'
|
|
```
|
|
|
|
## License
|
|
|
|
MIT
|
|
|
|
## Author Information
|
|
|
|
This role was created in 2022 by [Laur Ivan](https://www.laurivan.com).
|