Skip to content

Commit

Permalink
feat: add privacy policy (#1484)
Browse files Browse the repository at this point in the history
  • Loading branch information
danielroe authored Jan 27, 2023
1 parent 3904bc4 commit 541a1f9
Show file tree
Hide file tree
Showing 7 changed files with 48 additions and 2 deletions.
1 change: 1 addition & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
NUXT_PUBLIC_TRANSLATE_API=
NUXT_PUBLIC_DEFAULT_SERVER=
NUXT_PUBLIC_PRIVACY_POLICY_URL=

# Production only
NUXT_CLOUDFLARE_ACCOUNT_ID=
Expand Down
6 changes: 6 additions & 0 deletions components/nav/NavFooter.vue
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,12 @@ function toggleDark() {
<NuxtLink cursor-pointer hover:underline to="/settings/about">
{{ $t('settings.about.label') }}
</NuxtLink>
<template v-if="$config.public.privacyPolicyUrl">
&middot;
<NuxtLink cursor-pointer hover:underline :to="$config.public.privacyPolicyUrl">
{{ $t('nav.privacy') }}
</NuxtLink>
</template>
&middot;
<NuxtLink href="/m.webtoo.ls/@elk" target="_blank">
Mastodon
Expand Down
2 changes: 0 additions & 2 deletions constants/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,4 @@ export const STORAGE_KEY_NOTIFICATION = 'elk-notification'
export const STORAGE_KEY_NOTIFICATION_POLICY = 'elk-notification-policy'
export const STORAGE_KEY_PWA_HIDE_INSTALL = 'elk-pwa-hide-install'

export const COOKIE_MAX_AGE = 10 * 365 * 24 * 60 * 60 * 1000

export const HANDLED_MASTO_URLS = /^(https?:\/\/)?([\w\d-]+\.)+\w+\/(@[@\w\d-\.]+)(\/objects)?(\/\d+)?$/
1 change: 1 addition & 0 deletions docs/content/2.deployment/1.netlify.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ There are 5 environment variables to add.
| NUXT_CLOUDFLARE_NAMESPACE_ID | This is your CloudFlare KV Namespace ID. You can find it in "Workers > KV". |
| NUXT_STORAGE_DRIVER | Because we're using CloudFlare, we'll need to set this to `cloudflare`. |
| NUXT_PUBLIC_DEFAULT_SERVER | This is the address of the Mastodon instance that will show up when a user visits your Elk deployment and is not logged in. If you don't make that variable, it will point to `m.webtoo.ls` by default. |
| NUXT_PUBLIC_PRIVACY_POLICY_URL | This is the URL to a web page with information on your privacy policy. |

That's it! All that's left to do is...

Expand Down
38 changes: 38 additions & 0 deletions docs/content/privacy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Privacy

> Last updated January 27, 2023
This privacy notice for Elk describes how we handle your information when you:

- Visit https://elk.zone, https://main.elk.zone or https://docs.elk.zone.

- Download and use our mobile or desktop application (Elk)

::alert{type=warning}
Elk is [open source](https://github.com/elk-zone/elk) and other websites that link to this privacy notice may not be affiliated with Elk or bound by this policy.
::

## Information

We do not collect or process your personal or sensitive information.

The only information retained by Elk when you use it is the host name of your Mastodon instance, which we need in order to log you in to that instance.

We use two third-party providers to provide server and content delivery network (CDN) capacity. They each have their own privacy policies which you can read: [Cloudflare](https://www.cloudflare.com/privacypolicy/) and [Netlify](https://www.netlify.com/privacy/).

We use aggregated information from these third-party providers to let us know about traffic and visits to Elk.

## Tracking

We do not use tracking technologies (for example, cookies). We store information about your user interface preferences in your local browser storage.

## Updates

We will update this notice as necessary to stay compliant with relevant laws.

When we update this privacy notice, the updated version will be indicated by a new 'Revised' date. The updated version will be effective as soon as it is accessible. If we make material changes to this privacy notice, we may notify you either by prominently posting a notice of such changes or by directly sending you a notification. We encourage you to review this privacy notice frequently to be informed of how we are protecting your information.

## Contact

If you have questions or comments about this notice, you may raise an issue at https://github.com/elk-zone/elk.

1 change: 1 addition & 0 deletions locales/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,7 @@
"local": "Local",
"muted_users": "Muted users",
"notifications": "Notifications",
"privacy": "Privacy",
"profile": "Profile",
"search": "Search",
"select_feature_flags": "Toggle Feature Flags",
Expand Down
1 change: 1 addition & 0 deletions nuxt.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ export default defineNuxtConfig({
apiToken: '',
},
public: {
privacyPolicyUrl: '',
env: '', // set in build-env module
buildInfo: {} as BuildInfo, // set in build-env module
pwaEnabled: !isDevelopment || process.env.VITE_DEV_PWA === 'true',
Expand Down

0 comments on commit 541a1f9

Please sign in to comment.