diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..33151dd --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,8 @@ +Copyright 2024 spearcat + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + diff --git a/README.md b/README.md index 35d2164..c3061ca 100644 --- a/README.md +++ b/README.md @@ -1 +1,7 @@ # atproto-obsidian-sync + +**NOTE: atproto-obsidian-sync has not been security audited or battle-tested. For production use, if you care about your data, I highly recommend you use something like SFTP to a secure server, or another backup tool such as Borg, Kopia, Rclone with encryption, Restic, etc. For syncing between your mobile and desktop devices, consider Syncthing or the official Obsidian sync functionality.** + +**One limitation of atproto-obsidian-sync is your keys are stored in the database (in encrypted form), so if your passphrase is compromised, all your files are also compromised. Because of the open and public nature of records on the AT Protocol, key rotation probably wouldn't be too useful to prevent this kind of attack, as attackers can store copies of your encrypted data ahead of time.** + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.