-
Notifications
You must be signed in to change notification settings - Fork 15
docs: rotki premium #98
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.
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
Open
lukicenturi
wants to merge
2
commits into
main
Choose a base branch
from
rotki-premium
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,11 +36,35 @@ If you like rotki, you can support us with a premium subscription and you not on | |
|
|
||
| Short answer: **No** | ||
|
|
||
| At rotki, we believe in building sustainable, long-term software that delivers continuous value to our users. Offering a lifetime subscription may sound appealing on the surface, but in reality, it’s a model that often leads to the collapse of the very products it’s meant to support. Many companies that adopt this approach either shut down within a few years or abandon the product once the initial influx of revenue dries up. | ||
| At rotki, we believe in building sustainable, long-term software that delivers continuous value to our users. Offering a lifetime subscription may sound appealing on the surface, but in reality, it's a model that often leads to the collapse of the very products it's meant to support. Many companies that adopt this approach either shut down within a few years or abandon the product once the initial influx of revenue dries up. | ||
|
|
||
| rotki has been around since 2017, delivering continuous, original improvements every month. Offering a lifetime subscription would require us to put a fixed price on the indefinite future work of our entire team, which is simply not realistic or fair. Building and maintaining a privacy-respecting, local-first, open-source financial tool involves real and growing costs. | ||
|
|
||
| It’s also worth noting that our current pricing model hasn’t changed since 2017. We’re currently re-evaluating it to better reflect the actual cost of development, support, and infrastructure, especially in light of inflation and the expanded scope of what rotki offers today. Our goal is to keep rotki accessible while ensuring its long-term health and independence. | ||
| It's also worth noting that our current pricing model hasn't changed since 2017. We're currently re-evaluating it to better reflect the actual cost of development, support, and infrastructure, especially in light of inflation and the expanded scope of what rotki offers today. Our goal is to keep rotki accessible while ensuring its long-term health and independence. | ||
|
|
||
| ### How do I manage my premium subscription? | ||
|
|
||
| You can manage your premium subscription, payment methods, devices, and referrals through your rotki.com account. See the [Premium documentation](/premium/) for detailed guides on: | ||
|
|
||
| - [Managing your subscription](/premium/subscription) - View payment history, cancel subscription | ||
| - [Payment methods](/premium/payment-methods) - Add, remove, or change cards | ||
| - [Device management](/premium/devices) - Manage device limits | ||
| - [Referral program](/premium/referrals) - Create and share referral codes | ||
|
|
||
| ### How do device limits work? | ||
|
|
||
| Each premium tier has a device limit. You can manage your devices from the app (**Settings → Account → Premium Devices**) or from the [website](https://rotki.com/home/devices). | ||
|
|
||
| If you exceed your device limit, remove unused devices to continue using rotki. See [Device Management](/premium/devices) for more information. | ||
|
|
||
| ### Need help with premium? | ||
|
|
||
| If you have questions about premium subscriptions, payment, billing, or account management: | ||
|
|
||
| - Check the answers above in this FAQ section | ||
| - Visit the [Premium documentation](/premium/) for detailed guides | ||
| - Contact support at [[email protected]](mailto:[email protected]) | ||
| - Join our [Discord community](https://discord.rotki.com) | ||
|
|
||
| ## Questions on Roadmap and Features | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| # API Credentials | ||
|
|
||
| rotki premium uses API credentials to connect your subscription to the rotki application. This guide explains how to create, manage, and secure your API credentials. | ||
|
|
||
| ## What are rotki Premium API Credentials? | ||
|
|
||
| The API Key and Secret are authentication credentials that: | ||
|
|
||
| - Link your rotki app to your premium subscription | ||
| - Enable premium features in the application | ||
| - Allow cloud backup and sync across devices | ||
| - Identify your account for device limit management | ||
|
|
||
| ## Creating API Credentials | ||
|
|
||
| After purchasing a subscription, you need to manually generate your API credentials: | ||
|
|
||
| 1. Go to your [subscription page](https://rotki.com/home/subscription) | ||
| 2. Navigate to the **API Credentials** section | ||
| 3. Click the **Create** button | ||
| 4. Your credentials will be generated and displayed: | ||
| - **API Key** - Your public identifier | ||
| - **API Secret** - Your private authentication token | ||
| 5. You can view both credentials anytime from your subscription page | ||
|
|
||
| ::: info Manual Generation Required | ||
| API Credentials are not automatically created after payment. You must click the button to generate them for the first time. | ||
| ::: | ||
|
|
||
| ## Using API Credentials in the App | ||
|
|
||
| After creating your API credentials, add them to rotki: | ||
|
|
||
| 1. Open the rotki application | ||
| 2. Navigate to **API Keys** → **rotki Premium** in the sidebar | ||
| 3. Enter your **API Key** and **API Secret** | ||
| 4. Click **Setup** | ||
|
|
||
|  | ||
|
|
||
| ## Managing API Credentials | ||
|
|
||
| ### Viewing Your Credentials | ||
|
|
||
| From your [subscription page](https://rotki.com/home/subscription): | ||
|
|
||
| - Both your API Key and Secret are always visible | ||
| - You can copy them anytime you need | ||
| - You can see when the key was created | ||
|
|
||
| ### Regenerating Credentials | ||
|
|
||
| If you need to create new credentials: | ||
|
|
||
| 1. Go to your [subscription page](https://rotki.com/home/subscription) | ||
| 2. Click the **Regenerate** button | ||
| 3. Your new API Key and Secret will be generated and displayed | ||
| 4. Update credentials on all your devices | ||
|
|
||
| ::: tip When to Regenerate | ||
|
|
||
| - If you suspect your credentials have been compromised | ||
| - If you want to revoke access from all devices | ||
| ::: | ||
|
|
||
| ## Security Best Practices | ||
|
|
||
| ### Protecting Your Credentials | ||
|
|
||
| ::: danger Keep Your Secret Safe | ||
|
|
||
| - **Never** share your API Secret with anyone | ||
| - **Never** post it in public forums or Discord | ||
| - **Never** commit it to version control (Git, etc.) | ||
| - **Never** send it via unencrypted channels | ||
| ::: | ||
|
|
||
| ### Storage Recommendations | ||
|
|
||
| Store your API credentials securely: | ||
|
|
||
| - Use a password manager (1Password, Bitwarden, KeePass, etc.) | ||
| - Keep backups in a secure location | ||
| - Don't save them in plain text files | ||
| - Don't email them to yourself | ||
|
|
||
| ### If Credentials are Compromised | ||
|
|
||
| If you believe your API credentials have been exposed: | ||
|
|
||
| 1. **Immediately** regenerate your API credentials from the [subscription page](https://rotki.com/home/subscription) by clicking **Regenerate** | ||
| 2. Update all your legitimate devices with the new credentials | ||
| 3. Monitor your account for unusual activity | ||
|
|
||
| ## API Keys and Device Limits | ||
|
|
||
| Each premium tier has a device limit. Each rotki app account where you add your | ||
| API credentials is registered as a new device and counts toward your device limit. | ||
|
|
||
| For more information about managing your devices, device limits, and what to do | ||
| when you exceed your device limit, see the [Device Management](/premium/devices) documentation. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Invalid API Key/Secret Error | ||
|
|
||
| If you see authentication errors: | ||
|
|
||
| 1. Verify you copied the credentials correctly (no extra spaces) | ||
| 2. Ensure your subscription is active (check [subscription page](https://rotki.com/home/subscription)) | ||
| 3. Verify your API credentials are still visible on the subscription page | ||
| 4. Try regenerating your credentials | ||
|
|
||
| ### Can't See My API Key/Secret | ||
|
|
||
| If you can't see your credentials on the subscription page: | ||
|
|
||
| 1. Verify you're logged in to the correct rotki.com account | ||
| 2. Ensure you've already generated API credentials (if not, click the generate button) | ||
| 3. Refresh the page | ||
| 4. Contact [[email protected]](mailto:[email protected]) if the issue persists | ||
|
|
||
| ### Premium Features Not Working | ||
|
|
||
| If premium features aren't activating: | ||
|
|
||
| 1. Verify API credentials are entered correctly in the app | ||
| 2. Check your subscription is active and not expired | ||
| 3. Ensure you haven't exceeded your device limit | ||
| 4. Try removing and re-adding the credentials | ||
| 5. Check the app logs for specific errors | ||
|
|
||
| When premium is successfully activated in the app you should see a `rotki Premium is active` banner in the rotki Premium view. | ||
|
|
||
|  | ||
|
|
||
| ### Multiple Devices Not Syncing | ||
|
|
||
| If sync isn't working across devices: | ||
|
|
||
| 1. Verify all devices use the same API credentials | ||
| 2. Ensure "Allow data sync with rotki Server" is enabled (see [Sync Guide](/usage-guides/#sync-data-with-rotki-server)) | ||
| 3. Check you haven't exceeded device limits | ||
| 4. Manually trigger sync from the toolbar | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.