Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SFTPGo configuration #122

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

SFTPGo configuration #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
561cd88
SFTPGo config
enggnr Nov 21, 2023
8326eab
Add documentation about JumpCloud related secrets
enggnr Nov 22, 2023
dc43100
Add LDAP integration
enggnr Nov 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/customization/secrets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ The following table details all the custom variables supported by Install Doctor
Unless otherwise specified in the description column, all of the variables in this chart can be stored as secrets by saving the encrypted secret environment variable in the `home/.chezmoitemplates/secrets/` folder (with a file name equal to the environment variable name). So, if you wanted to saved your `GITHUB_TOKEN` as an encrypted secret in your fork then you would encrypt following the instructions detailed above and then saved the encrypted secret in the `home/.chezmoitemplates/secrets/GITHUB_TOKEN` location (e.g. `echo "MY_GITHUB_API_TOKEN" | chezmoi encrypt > "home/.chezmoitemplates/secrets/GITHUB_TOKEN"`).

| Variable | Description |
| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `AGE_PASSWORD` | Automate the Chezmoi Age decryption process by passing in the passphrase for the `key.txt.age` file stored in the `home/` folder (which is used to encrypt all your secrets). _This variable can only be passed in as an environment variable._ |
| `ANSIBLE_GALAXY_TOKEN` | Ansible Galaxy API token stored in `~/.config/shell/private.sh` so developer API keys can be loaded by running `source "~/.config/shell/private.sh"`. |
| `ANSIBLE_VAULT_PASSWORD` | Ansible Vault password stored in `~/.config/shell/private.sh` so developer API keys can be loaded by running `source "~/.config/shell/private.sh"`. |
Expand Down Expand Up @@ -206,6 +206,9 @@ Unless otherwise specified in the description column, all of the variables in th
| `HOST` | The hostname of the device. Used for a FQDN that resolves to the device when combined with the \_ `PUBLIC_SERVICES_DOMAIN`. |
| `IFTTT_WEBHOOK_ID` | Webhook ID from the [Maker webhook on IFTTT](https://ifttt.com/maker_webhooks/settings). This is used to integrate [Apprise with IFTTT integration](https://github.com/caronc/apprise/wiki/Notify_ifttt). |
| `JUMPCLOUD_CONNECT_KEY` | JumpCloud device enrollment key. |
| `JUMPCLOUD_ORG_ID` | Unique ID for you organization. You can obtain this by logging on to [JumpCloud Admin Portal](https://console.jumpcloud.com/) and navigating to _Settings > Organization Profile > General_ and copying the **Organization ID**. |
| `JUMPCLOUD_BINDDN_USER` | User to connect to LDAP. This is a user account in JumpCloud LDAP. This user needs to have **Enable as LDAP Bind DN** enabled under _User Security Settings and Permission​ > Permission Settings_​​​​ |
| `JUMPCLOUD_BINDDN_PASSWORD` | Password of the LDAP BINDDN User account. |
| `KEYID` | Your GPG key ID available on the MIT or Ubuntu servers. During provisioning, the key will be imported and trusted with an elevated trust level. This can only be passed in as an environment variable or be hardcoded into the `home/.chezmoi.yaml.tmpl` file. |
| `MATRIX_PASSWORD` | Password for user account for matrix.org through [Element](https://app.element.io/). Used to integrate [Matrix chatting with Apprise](https://github.com/caronc/apprise/wiki/Notify_matrix). |
| `MATRIX_USERNAME` | Username for user account for matrix.org through [Element](https://app.element.io/). Used to integrate [Matrix chatting with Apprise](https://github.com/caronc/apprise/wiki/Notify_matrix). |
Expand Down Expand Up @@ -239,7 +242,7 @@ Unless otherwise specified in the description column, all of the variables in th
| `SFTPGO_DEFAULT_ADMIN_USERNAME` | Username for default admin user that can login to the [SFTPGo](https://github.com/drakkan/sftpgo) web interface. |
| `SLACK_API_TOKEN` | Slack API personal access token that populates `~/.config/slack-term/config` so that you can use Slack from your terminal with [slack-term](https://github.com/jpbruinsslot/slack-term). |
| `SLACK_BOT_USER_OAUTH_TOKEN` | Slack bot OAuth token. Used by Apprise Slack integration so that user can post to Slack (with support for attachments) from the CLI. |
| `SNAPCRAFT_EMAIL` | Snapcraft.io e-mail address associated with the `SNAPCRAFT_MACAROON` and `SNAPCRAFT_UNBOUND_DISCHARGE` (detailed below). Stored in `~/.config/shell/private.sh` so developer API credentials can be loaded by running `source "~/.config/shell/private.sh"`. \*Can only be included as an environment variable or hardcoded into `home/.chezmoi.yaml.tmpl`. | |
| `SNAPCRAFT_EMAIL` | Snapcraft.io e-mail address associated with the `SNAPCRAFT_MACAROON` and `SNAPCRAFT_UNBOUND_DISCHARGE` (detailed below). Stored in `~/.config/shell/private.sh` so developer API credentials can be loaded by running `source "~/.config/shell/private.sh"`. \*Can only be included as an environment variable or hardcoded into `home/.chezmoi.yaml.tmpl`. |
| `SNAPCRAFT_MACAROON` | Snapcraft.io authentication variable stored in `~/.config/shell/private.sh` so developer API keys can be loaded by running `source "~/.config/shell/private.sh"`. |
| `SNAPCRAFT_UNBOUND_DISCHARGE` | Snapcraft.io authentication variable stored in `~/.config/shell/private.sh` so developer API keys can be loaded by running `source "~/.config/shell/private.sh"`. |
| `SOFTWARE_GROUP` | Should be equal to only of the software lists defined in `home/.chezmoidata.yaml` (see the [Customization](/docs/customization) page for more details). |
Expand Down
2 changes: 1 addition & 1 deletion home/dot_local/etc/cloudflared/config.yml.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ ingress:
# Rules can match the request's hostname to a wildcard character:
# - hostname: "*.example.com"
# service: https://localhost:8002
- service: http_status:404
- service: http_status:404
2 changes: 1 addition & 1 deletion home/dot_local/etc/sftpgo/banner
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ WARNING! Authorized use only. Your IP address has been logged.

If you choose to ignore this warning and discover a vulnerability
that you can explain how to remediate, then please contact [email protected]
for a bounty.
for a bounty.
Binary file added home/dot_local/etc/sftpgo/branding/favicon.ico
View file
Open in desktop
Binary file not shown.
Binary file added home/dot_local/etc/sftpgo/branding/login_image.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added home/dot_local/etc/sftpgo/branding/logo.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions software.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10387,6 +10387,8 @@ softwarePackages:
- sftpgo-plugin-auth
_bin: sftpgo
_desc: Fully featured and highly configurable SFTP server with optional HTTP/S, FTP/S and WebDAV support - S3, Google Cloud Storage, Azure Blob
_deps:
- sftpgo-plugin-auth
_docs: null
_github: https://github.com/drakkan/sftpgo
_home: null
Expand All @@ -10411,6 +10413,14 @@ softwarePackages:
github: github.com/drakkan/sftpgo
pkg: sftpgo
yay: sftpgo-bin
sftpgo-plugin-auth:
_bin: sftpgo-plugin-auth
_desc: A plugin for SFTPGo to enable LDAP/Active Directory authentication
_docs: null
_github: https://github.com/sftpgo/sftpgo-plugin-auth
_home: null
_name: sftpgo-plugin-auth
github: github.com/sftpgo/sftpgo-plugin-auth
share:
_bin: share
_desc: Quickly share files from your command line
Expand Down
Loading