tristonarmstrong/XeNote
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

delete posts

Browse Source
This commit is contained in:
Triston Armstrong 2023-12-23 21:27:28 -06:00
parent abfd0e74b3
commit 44aa86d5cd
6 changed files with 0 additions and 511 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
posts/Licenses & add-on services/Catalyst license.md
View File

@ -1,47 +0,0 @@
Obsidian is free for personal use. A Catalyst license is an optional license that provides the following benefits:
1. It gives you early access to the latest, cutting edge versions of the app;
2. Provides you cool badges on our community Discord server and forum; and
3. It helps support the development of Obsidian (thank you 💜!)
There are three tiers of the Catalyst license: Insider ($25), Supporter ($50), and VIP ($100) - each of which gives you [[Insider builds|access to insider builds]].
Please note that Catalyst is optional and ==does not give you any additional app features==.
To upgrade to Catalyst, please visit [our pricing page](https://obsidian.md/pricing).
If you use Obsidian for work-related activities, you may need a [[Commercial license|commercial license]].
## FAQ
### How do I get my shiny badges after I upgrade?
Congratulations! After upgrading, you will find two buttons in the "Catalyst" section in your Account page.
#### Discord badge
==Please make sure to join [our Discord server](https://discord.gg/veuWUTm) first.==
In [your account page](https://obsidian.md/account), click on "Get Discord badge", which will authenticate with Discord and add the badge for you automatically.
#### Forum badge
==Please make sure you've registered an account at [our forum](https://forum.obsidian.md) with the same email address.==
In [your account page](https://obsidian.md/account), click on "Get forum badge" , which will add the badge to your forum account.
If your forum email doesn't match your account email, the badge can't be added. In that case, please change your email in the forum to be consistent with your account email.
Please note that your forum badge is not a "badge" in the forum system, but a shiny gold tag right next to your name in all of your posts.
### What do I get when I pay for Catalyst?
You get access to our [[Insider builds]]. On top of that, if you get Supporter or VIP tier, you can access an exclusive Discord channel to hang out with the developers.
When we do closed beta for a big new feature (such as mobile apps or a Typora-like WYSIWYM mode), we will roll out the beta to VIPs, Supporters, Insiders, and then everyone else, fixing issues along the way.
### What payment methods do you accept?
Our website accepts credit cards and some debit cards. This method is the quickest and easiest.
If you need to pay via PayPal or Wechat, it's also possible. Please find the instructions by logging in on our website and select the "Catalyst" option.

53
posts/Licenses & add-on services/Commercial license.md
View File

@ -1,53 +0,0 @@
### About Obsidian commercial license
Obsidian is free for personal use. For commercial (business) use in a company of two (2) or more employees, a commercial license is required. Business use includes any work-related activities such as capturing meeting notes, maintaining team project notes, configuring an organizational wiki, and similar note taking, document management, or knowledge management functionality.
To purchase a commercial license, please visit [our pricing page](https://obsidian.md/pricing).
### Frequently asked questions
##### Can I try Obsidian for commercial use before paying?
Yes. You may evaluate Obsidian for commercial use for 14 days.
##### Do non-profit organizations require a commercial license?
No, non-profit organizations may use Obsidian without a commercial license.
##### Are there bulk discounts?
For bulk discount inquiry, please contact us at support@obsidian.md.
##### How can I ask my company to purchase licenses for me or my team?
Ask your IT department to contact support@obsidian.md if they have questions or require any specific paperwork.
##### Do I need a commercial license?
From our EULA:
> If you use OBSIDIAN for commercial use, you must obtain a commercial license. Commercial use is defined as using OBSIDIAN for work-related activities in a company with two (2) or more employees.
Some examples to help determine if you require a commercial license:
> *Q1. I'm a freelancer/writer/blogger, do I need a commercial license?*
> \
> A: Unless you hire at least one additional person, you do not need a commercial license.
> *Q2. I'm a teacher/professor and I use Obsidian for my teaching/lectures, do I need a commercial license?*
> \
> A: Obsidian usage for education-related activities within schools and other recognized educational institutions does not require a commercial license.
> *Q3. I'm a researcher and I use Obsidian for my research, do I need a commercial license?*
> \
> A: If your organization consists of two or more people and the research is on behalf of a commercial product, then you would require a commercial license. If the research is not for any commercial purpose, then you may use Obsidian without a commercial license.
> *Q4. I use Obsidian during work for things like writing down team processes and taking notes for team meetings, do I need a commercial license?*
> \
> A: If you are a single-person company, then you do not require a commercial license. Otherwise, if you have more than one person in the company, then you would require a commercial license.
> *Q5. I use Obsidian to store all of my knowledge, both personal and professional, because it's difficult to separate them. Do I need a commercial license?*
> \
> A: If your notes contain content directly related to work projects or processes for a greater-than-one-person company, then you require a commercial license.
If you still have questions regarding the commercial license requirements, email us at support@obsidian.md and describe your situation in detail.

211
posts/Licenses & add-on services/Obsidian Publish.md
View File

@ -1,211 +0,0 @@
Obsidian Publish™ is a paid hosting service for your notes.
For instructions on how to publish your notes from within the Obsidian app, refer to the [[Publish|Publish plugin]].
### Privacy
You have total control over what to publish via the [[Publish|Publish plugin]] - either your entire vault or just selected notes within your vault. As for any notes you choose **not** to publish, you can be confident that those notes remain completely private, and Obsidian Publish has no knowledge of them.
### Backing up
Please note that Obsidian Publish is not to be used as a backup for your content. Make sure you always have a personal backup copy of your site using your preferred backup method. Our efforts on Obsidian Publish will be more focused on functionality, ease of use, and site availability.
### Demo
There's a good chance that you're already viewing this article on our official site powered by Obsidian Publish.
If not, you can visit it here: https://publish.obsidian.md/help.
### What's included
The Obsidian Publish service lets you create your site directly from within the Obsidian app by choosing the notes you want to publish.
To customize your site, you can choose between light and dark mode, and also toggle between readable line length and full page length.
There are several components which can be turned on or off from the [[Publish|Publish plugin]]. Changes to these options will be reflected on your published site once the cache clears, typically within 5 minutes.
##### Navigation
Enabling this option adds a navigation sidebar displaying all published pages and the folders that contain them. Viewers will see the current open note highlighted, and can click on any other note to navigate.
##### Search bar
Adds a search bar to page. This bar can be used to search for pages, aliases, and headings within pages. It does not currently search through the full text content of the site.
##### Graph view
Displays a local graph of the page currently open. This uses the same rendering engine as the [[Graph view]] plugin in Obsidian.
##### Table of contents
Displays a table of contents for the page currently open. The list is generated from headings within the page, similar to the [[Outline]] plugin. Viewers navigating the note will see the corresponding heading highlighted as they scroll, and can click on another heading to immediately navigate to it.
##### Backlinks
Displays a section at the end of each page called "Linked to this page", containing backlinks from other pages. If there are no backlinks, the section will not be displayed.
##### Tags
When the reader clicks on a tag, they can see a list of other pages that includes the same tag.
##### Hover preview
When hovering over links, their content is displayed within a popup box. This works similarly to the [[Page preview]] plugin in Obsidian.
##### Custom CSS
To customize the styling of your site, you can upload a `publish.css`. This file must be stored in the root folder of your site. You can use your existing theme and add some extra tweaks for publish in `publish.css`.
##### Favicon
To change the favicon of your site, you can upload `png` icons of any size in the format of `favicon-32.png` or `favicon-32x32.png`. You can also upload the file `favicon.ico`. These files can be stored in any folder. The current recommendation (as of 2020) is to provide sizes `32×32`, `128x128`, `152×152`, `167x167`, `180x180`, `192x192`, and `196x196`.
##### Custom JS
If you wish to execute your own JavaScript code to change the visitor experience, or add various integrations like Discus!, Discourse, etc. you can do so by uploading `publish.js` inside the root of your vault. Note that these scripts will only run for visitors to your custom domain.
##### Disallow search engine indexing
This option adds a meta noindex tag to all your pages so search engines like Google does not index your site. Note that search engines won't be able to index your site anyway if it's password protected.
##### Google Analytics
If you wish to setup Google Analytics for your site, first make sure your local laws and regulations allows. Then, you just need to put the tracking code, in the form of `UA-XXXXX-Y` into the text box and your site will automatically track page views. Note that Google Analytics is only available to visitors from your custom domain.
When testing Google Analytics, please make sure to disable any ad-blocking browser extensions like uBlock Origin which blocks Google Analytics scripts from running.
Also, Obsidian Publish isn't directly compatible with Google Tag Manager at the moment - you can set it up using custom javascript if you wish to use Google Tag Manager instead of Google Analytics.
### Custom domain
You can setup a custom domain or subdomain for your Obsidian Publish site. Currently, we don't yet have a way to provision SSL certificate on your behalf, so you need to resort to either an SSL-enabled server of your own, or to setup your site on CloudFlare, which provides SSL for free.
You can also setup Obsidian Publish as a sub-URL of a site you own. For example, `https://mysite.com/my-notes/`. To achieve this, you must host your own server and proxy all requests to our server at `https://publish.obsidian.md/`.
Continue reading for setup details.
#### CloudFlare setup
The easiest way to setup a custom domain or subdomain is by making an account with [CloudFlare](https://cloudflare.com) and letting CloudFlare manage your domain. This allows you to add SSL to your site for free, as well as ensure your site is fast wherever in the world it's accessed from. Typically users will host their Obsidian Publish content on a root domain (e.g. `mysite.com`) or an immediate subdomain (e.g. `notes.mysite.com`). These instructions work for both cases.
1. Open Cloudflare to the domain you wish to add Publish to (e.g. `mysite.com`, even if you want a subdomain like `notes.mysite.com`).
2. Go to DNS and click Add Record. Select CNAME, and in 'name' enter the domain or subdomain you wish (e.g. `notes.mysite.com`). In 'target', enter the value `publish-main.obsidian.md`. Do not include your personal sub-URL in this value, as Obsidian Publish handles this from your configuration.
3. Go to SSL/TLS and set the SSL/TLS encryption mode to `Full`. This will configure the SSL/TLS certificate automatically.
Once you are done with configuring CloudFlare, you can head to your site options in Obsidian, and set the URL to your domain or subdomain. This allows our server to associate the domain to your site.
Troubleshooting: If your custom domain setup ends up in a redirect loop, it's likely that the encryption mode in CloudFlare to `Flexible` instead of `Full`.
If you wish to configure both `mysite.com` and `www.mysite.com` to Obsidian Publish, you will need to create a [Page Rule](https://support.cloudflare.com/hc/en-us/articles/200172336-Creating-Page-Rules) as follows:
- URL match: `www.mysite.com/*`
- Foward URL - 301 Permanent Redirect
- Redirect URL: `https://mysite.com/$1`
Once you create the page rule, you should also create a CNAME record for `www.mysite.com` just like you created for `mysite.com`
#### Proxy/redirect setup
If you wish to host your own web server and setup your own SSL encryption, you can choose this option. If you are already hosting a website under your domain or subdomain, you can also use this option and setup your website to load your Obsidian Publish site under a specific URL path, instead of hosting the full site.
Simply proxy all requests under that URL path to `https://publish.obsidian.md/serve?url=mysite.com/my-notes/...` and **configure the site options in Obsidian to the same URL path** by setting **Custom URL** to `mysite.com/my-notes`.
##### NGINX
```nginx
location /my-notes {
proxy_pass https://publish.obsidian.md/serve?url=mysite.com/my-notes/;
proxy_ssl_server_name on;
}
```
##### Apache
Add to `.htaccess`:
```htaccess
RewriteEngine on
RewriteRule "^my-notes/(.*)$" "https://publish.obsidian.md/serve?url=mysite.com/my-notes/$1" [L,P]
```
Note: mod_rewrite must be enabled, and you may also need to configure [SSLProxyEngine](https://stackoverflow.com/questions/40938148/reverse-proxy-for-external-url-apache)
##### Netlify
```
[[redirects]]
from = "https://mysite.com/my-notes/*"
to = "https://publish.obsidian.md/serve?url=mysite.com/my-notes/:splat"
status = 200
force = true
```
##### Vercel
In `vercel.json` [configure rewrites](https://vercel.com/docs/configuration#project/rewrites):
```json
{
...
"rewrites": [
{
"source": "/my-notes/",
"destination": "https://publish.obsidian.md/serve?url=mysite.com/my-notes"
},
{
"source": "/my-notes/:path*",
"destination": "https://publish.obsidian.md/serve?url=mysite.com/my-notes/:path*"
}
]
}
```
##### Supported HTTP X-Headers
Alternatively, if your proxy service does not allow query paths, you can use `https://publish.obsidian.md/` with a custom header `x-obsidian-custom-domain` set to your site url `mysite.com/my-subpath`.
#### Custom domain post-setup issues
Once you setup your custom domain, if you've visited your site from your previous `https://publish.obsidian.md/slug` link, you may have to clear your browser cache for certain things (like fonts, graphs, or password access) to work properly. This is due to the cross-domain security restrictions that are imposed by modern browsers. The good news is that readers of your site should never run into issue this if you only let visitors use your custom domain.
#### Redirect old site to custom domain
If you'd like to redirect your visitors from the old `publish.obsidian.md` site to your new custom domain, there is an option you can enable in the custom domain settings page which will do just that.
### Coming up
Obsidian Publish is still in its early days. Here are some features we plan to add:
- Full custom domain support (with SSL certificate provisioning).
- Full text search.
- More built-in themes.
Please let us know if you have any Obsidian Publish feature requests by submitting a [forum request here](https://forum.obsidian.md/).
### Pricing
For the pricing of Obsidian Publish, please visit [our pricing page](https://obsidian.md/pricing).
### Technical details
Obsidian Publish uses Cloudflare as the CDN (content delivery network) to distribute your site across the globe for a faster access. This involves caching copies of the files of your site on some of the 200+ data centers to ensure the lowest latency for your readers and the site remain speedy and loads fast even if your viewer lives far away from our primary servers.
However, this does mean that when you change site settings, publish new content, or unpublish content, visitors might not see the latest version for a short while. Currently, our cache is configured to persist for an hour before it has to be "re-validated" to ensure the content hasn't changed.
If you've just published items but you are still seeing an older version, you can typically perform a "hard refresh" by holding the reload button and choosing "Hard reload" in the dropdown menu. Failing that, you can try clearing the browser cache or disabling cache using the developer tools in the network tab.
#### Hosting media files
While Obsidian Publish allows you to upload video clips, it is not optimized for video delivery. As such, your visitors may find that the videos on your site may not deliver a great experience.
We recommend using a proper video hosting service like YouTube or Vimeo to host your videos for Obsidian Publish. The advantages of using a proper video hosting site includes:
- Automatic re-encoding ensures that your videos can be played on all mobile devices regardless of what encoding format you used in your original file.
- Dynamic quality adjustment based on bandwidth availability and ensures that videos can be played smoothly without constantly pausing for "buffering".
- High efficiency video compression to ensure that visitors don't blow through their data cap when viewing your site.
- Global CDN allowing your videos to be loaded fast regardless of where your visitor is located in the world.
---
### Related
Refer to the [[Publish|Publish plugin]] for details on publishing your notes.

176
posts/Licenses & add-on services/Obsidian Sync.md
View File

@ -1,176 +0,0 @@
Obsidian Sync™ is a paid service to sync notes between vaults on various devices.
### How Obsidian Sync works
Obsidian Sync is fairly simple: once you hook up local vaults from multiple devices to the same remote vault, changes will be automatically synced between these local vaults, except for files and folders you instruct Obsidian to ignore.
### Features
Currently, Obsidian Sync features:
- End-to-end encryption.
- Version history integrated into Obsidian.
- View & restore deleted files.
- Synchronize settings, themes, CSS snippets, plugins, and plugin settings.
- Selective sync.
- Exclude certain folders.
- Toggle syncing for images, audio, video, PDF, and unsupported files.
- Switch between multiple remote vaults.
In the future, we'll improve Obsidian Sync with:
- Vault sharing
### Enable Obsidian Sync plugin
You can enable Obsidian Sync by enabling the "Sync" plugin under Settings => Core plugins.
### Setting up remote vaults
Warning: We do not recommend using third party sync services to sync the same vault with Obsidian Sync. [[#Third party sync|More about this later]].
To start syncing, first you need to create a remote vault that stores your encrypted data.
To do that, go to Setting => Sync => Pick remote vault => Choose => Create new vault.
After creating it, you can immediately connect to the vault by clicking on the "Connect" button next to it.
You can choose to either start syncing immediately after connecting, or choose folders to ignore.
##### Set encryption password
By default, you need to set an encryption password for your vault. This password is used to encrypt and decrypt your data and is extremely important.
You'll be asked for the password any time you setup sync with an encrypted vault. ==If you forget or lose the password, your data will remain encrypted and unusable forever. We are unable to recover your password or any encrypted data for you.== Your local files are not affected.
You can also choose to turn off the "Custom end-to-end password" option to leave managing the encryption key to us. This is still fairly secure and provides the convenience of not having to remember a password.
### Check sync status
After connecting to a remote vault, you can check the current sync status in the bottom status bar. You can hover over the status icon to read more about what's going on.
Clicking on the status icon will open up sync settings as a shortcut.
### Version history
As you edit your notes, versions are saved approximately every 10 seconds. ==Version history is only available for notes, not attachments.==
You can right click a file in the file explorer pane to see its version history. This option is also available in the more options menu.
After selecting a version in the left column in the version history screen, you can restore the file to this version by clicking on the "Restore" button.
### Deleted files
After you delete a file, you can view it in Setting => Sync => Deleted files => View.
Clicking on a deleted file will open its version history. You can then choose to restore the file back to a previous version.
### Selective sync
You can selectively sync files by folder or file type. ==Selective sync only applies to future changes. Any files that have already been uploaded will not be deleted even if you choose to ignore them. Please be sure to configure it before starting the sync process.==
##### Exclude folders
You can uncheck folders in Settings => Sync => Excluded folders => Manage to prevent them from getting synced.
Excluded folders will be ignored when both uploading and download changes.
#### File types
You can toggle sync for images, audio, video, PDFs, and unsupported files under Settings => Sync => Selective sync.
### Synchronizing settings
In addition to your notes and attachments, Obsidian Sync offers individual toggles to synchronize these files:
- The main app settings, including editor settings, files & links settings, etc.
- Appearance settings, including dark mode, selected theme, and enabled snippets.
- Themes and snippets that has been downloaded.
- Hotkeys.
- Which [[Core plugins]] are enabled.
- Core plugin settings.
- Which community plugins are enabled.
- Downloaded/installed community plugins, and their settings.
You can choose which ones to synchronize with your remote vault to best suite your use case of Obsidian.
Keep in mind that Obsidian does not apply your settings until you restart the application, or reload the vault. This normally isn't a problem on mobile since the app restarts often, but you may notice that settings you set on one desktop device is "synced" to another device, but doesn't take effect until the next restart.
Sync will respect your selection of the settings folder override in case you've set it to a folder other than `.obsidian`. You can take advantage of this to create different profiles in your remote vault to sync your settings. A common use case, for example, is to use a different profile for mobile devices vs desktop devices.
#### Settings version history
If something goes wrong, and you lost some of your settings, you can always revert the affected settings file through the "Settings version history" section in Sync.
### Third party sync
If you are using Obsidian Sync, we do not recommend using third party sync services like Dropbox, Google Drive, OneDrive, or iCloud to sync the same vault between the same devices using Obsidian Sync. Doing so may cause conflicts, duplicate files, or in the worst case, could lead to corrupted files.
If you do setup Obsidian Sync and a third party sync service to sync a vault between two devices, then the following will happen:
- If Obsidian Sync "wins" the race and syncs your file first, then your third party sync service will generate a "conflicted copy".
- If your third party sync service "wins" the race and syncs your file first, then Obsidian Sync will attempt to merge the two slightly different versions, often causing the last few characters you just typed to be rolled back.
If you wish to maintain a backup of your vault using a third party sync service, you can still do so by setting up your sync provider on your primary single device, but not on your secondary devices. This will ensure that your third party sync service does not "race" with Obsidian Sync.
### FAQ
##### What is end-to-end encryption?
End-to-end encryption means the data is encrypted from the moment it leaves your device, and can only be decrypted using your encryption key once it's back on one of your devices.
We do not have the capability of reading your data, nor do any potential eavesdroppers, such as your internet service provider.
In the rare case of a complete server breach, your data will remain encrypted, and nobody will have the ability to decrypt your files without knowing your password.
##### How many remote vaults can I have?
Each account with Obsidian Sync can have up to 5 remote vaults.
##### How long is version history kept?
Version histories are kept for up to one year before we clean it up.
##### How large can each remote vault be?
At the moment, each remote vault can have up to 4 GB of data, including version history.
##### Is my data encrypted on my hard disk?
No, your data is still in plain text on your hard disk. If you wish to encrypt it from people who use your computer, you should look for a disk encryption solution.
##### How long is my data kept after my subscription expires?
Data in your remote vaults, including version history, is kept for one month for you, after your subscription expires.
As long as you renew within one month, there should be no impact on your usage.
##### Can I use Obsidian Sync as a backup solution?
Obsidian Sync is designed as a data synchronization service, rather than a backup service.
With version history, it does provide some backup features, however we still recommend having additional backup measures.
Obsidian Sync is currently in beta testing, so we strongly recommend having backups, in case of software bugs and glitches.
##### Should I pick my own encryption password?
Pick your password if you require the highest level of security and privacy. This guarantees that anyone who doesn't know your password will never be able to read your notes.
Letting us manage your encryption key is more convenient, and you do not risk forgetting or losing your password.
Your local vault is not affected by this option. If you properly backup your local vault, this may not be a problem for you.
##### Is the end-to-end encryption strong?
We use industry-standard AES-256 to encrypt your data. AES-256 is a military-grade encryption specification that is widely used in online banking.
Here are the technical details for those interested:
- Key derivation function used: scrypt with salt
- Encryption algorithm used: AES-256 using GCM
##### What does the `vault limit exceeded` error mean?
Each vault using Obsidian Sync has a maximum size of 4gb. This error indicates your vault has exceeded that limit in size. Don't forget: attachments and version history contributes to the maximum, so you may exceed your 4gb limit even if your vault's actual size is less than 4gb.
If you see this error, Obsidian can help you identify and purge large files from the Vault. Go to the Obsidian Sync settings in Preferences => Sync and look for the "Vault size over limit" options.

9
posts/Licenses & add-on services/Obsidian Unlimited.md
View File

@ -1,9 +0,0 @@
Obsidian Unlimited is a way to contribute a custom amount to Obsidian develop as you wish. You can also contribute multiple times at any time.
You can find this option at the bottom of the page in [your Obsidian account page](https://obsidian.md/account) after logging in.
Special thanks to the VIPs who proposed this "feature" to support Obsidian even more.
==Contributing to Obsidian Unlimited does not let you give any additional features or benefits.== For this reason, we recommend upgrading to [[Catalyst license]] first, if you're looking to access [[Insider builds]] or get cool badges in our community.
Note: we've set the minimal amount to $5 (so that processing fees would make sense).

15
posts/Licenses & add-on services/Refund policy.md
View File

@ -1,15 +0,0 @@
## Obsidian Catalyst and Unlimited
[[Catalyst license]] purchases and Obsidian Unlimited donations are to support Obsidian's development. ==They are not refundable.==
Although they might give you exclusive early access to insider builds or feature betas, we do not sell them as a product.
We cannot provide refunds for Catalyst purchases. Thanks for your understanding!
If there is any issue with a transaction, please reach out to support@obsidian.md or on Discord.
## All other services
For all other services and licenses, including [[Commercial license]], [[Obsidian Publish]], and [[Obsidian Sync]], you can request a full refund within 3 days of purchase with no questions asked. Please reach out to support@obsidian.md or on Discord.
Beyond 3 days, if you need a refund due to exceptional circumstances, feel free to reach out to us too.