Rename sync.server.encryption_secret to sync.encryption_secret. (#3249)

* Rename `sync.server.encryption_secret` to `sync.encryption_secret`.

* move pwgen
This commit is contained in:
Dustin J. Mitchell 2024-01-21 19:11:24 -05:00 committed by GitHub
parent 082b6084fa
commit daca37806e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 15 additions and 13 deletions

View file

@ -48,6 +48,16 @@ Taskwarrior provides several options for synchronizing your tasks:
+ To a cloud storage provider. Currently only GCP is supported. + To a cloud storage provider. Currently only GCP is supported.
- To a local, on-disk file. - To a local, on-disk file.
For most of these, you will need an encryption secret used to encrypt and
decrypt your tasks. This can be any secret string, and must match for all
replicas sharing tasks.
$ task config sync.encryption_secret <encryption_secret>
Tools such as
.BR pwgen (1)
can generate suitable secret values.
.SS Sync Server .SS Sync Server
To synchronize your tasks to a sync server, you will need the following To synchronize your tasks to a sync server, you will need the following
@ -57,18 +67,11 @@ information from the server administrator:
- The server's URL ("origin", such as "https://tw.example.com") - The server's URL ("origin", such as "https://tw.example.com")
.br .br
- A client ID ("client_id") identifying your tasks - A client ID ("client_id") identifying your tasks
.br
- An encryption secret ("encryption_secret") used to encrypt and decrypt your tasks. This can be any secret string, and must match for all replicas using the same client ID.
Tools such as
.BR pwgen (1)
can generate suitable secret values.
Configure Taskwarrior with these details: Configure Taskwarrior with these details:
$ task config sync.server.origin <origin> $ task config sync.server.origin <origin>
$ task config sync.server.client_id <client_id> $ task config sync.server.client_id <client_id>
$ task config sync.server.encryption_secret <encryption_secret>
.SS Google Cloud Platform .SS Google Cloud Platform

View file

@ -279,8 +279,8 @@ std::string configurationDefaults =
"# WARNING: Please read the documentation (man task-sync) before setting up\n" "# WARNING: Please read the documentation (man task-sync) before setting up\n"
"# Taskwarrior for Taskserver synchronization.\n" "# Taskwarrior for Taskserver synchronization.\n"
"\n" "\n"
"#sync.encryption_secret # Encryption secret for sync to a server\n"
"#sync.server.client_id # Client ID for sync to a server\n" "#sync.server.client_id # Client ID for sync to a server\n"
"#sync.server.encryption_secret # Encryption secret for sync to a server\n"
"#sync.server.origin # Origin of the sync server\n" "#sync.server.origin # Origin of the sync server\n"
"#sync.local.server_dir # Directory for local sync\n" "#sync.local.server_dir # Directory for local sync\n"
"#sync.gcp.bucket # Bucket for sync to GCP\n" "#sync.gcp.bucket # Bucket for sync to GCP\n"

View file

@ -195,7 +195,7 @@ int CmdShow::execute (std::string& output)
" sync.local.server_dir" " sync.local.server_dir"
" sync.gcp.bucket" " sync.gcp.bucket"
" sync.server.client_id" " sync.server.client_id"
" sync.server.encryption_secret" " sync.encryption_secret"
" sync.server.origin" " sync.server.origin"
" tag.indicator" " tag.indicator"
" undo.style" " undo.style"

View file

@ -65,13 +65,13 @@ int CmdSync::execute (std::string& output)
std::string origin = Context::getContext ().config.get ("sync.server.origin"); std::string origin = Context::getContext ().config.get ("sync.server.origin");
std::string server_dir = Context::getContext ().config.get ("sync.local.server_dir"); std::string server_dir = Context::getContext ().config.get ("sync.local.server_dir");
std::string gcp_bucket = Context::getContext ().config.get ("sync.gcp.bucket"); std::string gcp_bucket = Context::getContext ().config.get ("sync.gcp.bucket");
std::string encryption_secret = Context::getContext ().config.get ("sync.encryption_secret");
if (server_dir != "") { if (server_dir != "") {
server = tc::Server::new_local (server_dir); server = tc::Server::new_local (server_dir);
server_ident = server_dir; server_ident = server_dir;
} else if (gcp_bucket != "") { } else if (gcp_bucket != "") {
std::string encryption_secret = Context::getContext ().config.get ("sync.gcp.encryption_secret");
if (encryption_secret == "") { if (encryption_secret == "") {
throw std::string ("sync.gcp.encryption_secret is required"); throw std::string ("sync.encryption_secret is required");
} }
server = tc::Server::new_gcp (gcp_bucket, encryption_secret); server = tc::Server::new_gcp (gcp_bucket, encryption_secret);
std::ostringstream os; std::ostringstream os;
@ -79,9 +79,8 @@ int CmdSync::execute (std::string& output)
server_ident = os.str(); server_ident = os.str();
} else if (origin != "") { } else if (origin != "") {
std::string client_id = Context::getContext ().config.get ("sync.server.client_id"); std::string client_id = Context::getContext ().config.get ("sync.server.client_id");
std::string encryption_secret = Context::getContext ().config.get ("sync.server.encryption_secret");
if (client_id == "" || encryption_secret == "") { if (client_id == "" || encryption_secret == "") {
throw std::string ("sync.server.client_id and encryption_secret are required"); throw std::string ("sync.server.client_id and sync.encryption_secret are required");
} }
server = tc::Server::new_sync (origin, client_id, encryption_secret); server = tc::Server::new_sync (origin, client_id, encryption_secret);
std::ostringstream os; std::ostringstream os;