AFFiNE selfhost

[Brooooooklyn]

Ask your questions about selfhost AFFiNE here

[phankhanhpvk]

hi how i can config google oauth

[Brooooooklyn]

Set these environment variables to the Docker image:

• OAUTH_GOOGLE_ENABLED=true
• OAUTH_GOOGLE_CLIENT_ID=YOUR_GOOGLE_CLIENT_ID
• OAUTH_GOOGLE_CLIENT_SECRET=YOUR_GOOGLE_CLIENT_SECRET

[ylbeethoven]

Did you remove the Google log in option in 0.13.0?

OAUTH_GOOGLE_ENABLED has no effect either

~$ docker exec -it affine sh
# printenv | grep OAUTH
OAUTH_GOOGLE_ENABLED=true

[darkskygit]

we have refactor the oauth logic as a plugins in 0.13
now as long as the OAUTH_GOOGLE_CLIENT_ID and OAUTH_GOOGLE_CLIENT_SECRET are configured, the relevant modules will be automatically enabled, therefore OAUTH_GOOGLE_ENABLED has been removed

[ylbeethoven]

Hi @darkskygit

I tried these 2 environment variable and I still don't see the google log in button.

~$ docker exec -it affine sh
# printenv | grep OAUTH
OAUTH_GOOGLE_CLIENT_ID=xxx
OAUTH_GOOGLE_CLIENT_SECRET=xxx

Version
AFFiNE
0.13.0
AFFiNE
Editor Version
0.13.0-canary-202403140735-2367cd5

[RandomLegend]

Do i understand correct i am limited to 10GB storage when selfhosting??? And still the 10MB upload max?

[forehalo]

That's not supposed to be. We will fix it.

[RandomLegend]

Awesome!

Is there an ETA ?

[glego]

Reference issue: #6641

[gymnae]

Hi there, thanks for putting in the effort to provide a ready-to-go Docker compose file, getting up and running was a breeze.
Couple of questions before I consider onboarding:

1. What are the licensing plans for self-hosting?
2. Why is a self-hosted installation connecting to affine.pro both in the back- and frontend?
3. Why does it state that I am on a free plan with the limitations of a free plan? I have not selected any plan
4. Will the limit to invite 3 other users to a workspace remain for the self-hosted variant?
5. Will you integrate custom OICD providers?

[RandomLegend]

I'm currently running the 0.13.0-canary-202403050653-934469c version and do still have the 10GB / 10MB Upload / 3 Users limitation.

I assume you will fix these in the 13.0 stable release?

Btw: Thanks for the quick responses. Awesome to see you open the project up for all us homelabbies

[gymnae]

I concurr with @RandomLegend, thank you for supporting us self-hosters, even if we fall outside of your revenue stream (for now - maybe some premium features will change that)

[RandomLegend]

I'd be happy to pay for a license. But i will never do anything subscription based i'm sorry.

If you'd offer some Lifetime License where we would get like 1 year of updates from the moment of purchase and then we can decide to stay on the last update or renew the license i'd love to support that.

But subscriptions are getting way too much. Too many things want to be subscription based and i really despise that.

[gymnae]

Hi there, with 0.13.0 the UI still shows the same limitations and "free" account note. Was it supposed to be "fixed", or is there a change of plan?

[darkskygit]

free plan for self-hosted flavor is an impl mistake, please pay attention to the progress of #6156

[RandomLegend]

Are there feature plans for:

1. Importing multiple markdown documents at once? (i have a big library of seperate markdown docs from Obsidian i want to mass import)
2. Make either a hotkey to add a Tag to a page or make it so tabbing after entering the title will jump to tags? I want to tag my documents without having to use the mouse
3. Save all the pages as markdown documents on the server. I'd love to be able to just go into the storage path and find a bunch of markdown documents for me to freely copy over and edit in any other software.

[dshiS]

That's awesome! Look forward to it!!

[dshiS]

I have deployed it on my machine. For some reason I cannot restart the docker container now after I upgrade my docker engine. Here is the error I got.

affine_selfhosted  | yarn run v1.22.19
affine_selfhosted  | $ yarn prisma migrate deploy && node --import ./scripts/register.js ./dist/data/index.js run
affine_selfhosted  | $ /app/node_modules/.bin/prisma migrate deploy
affine_selfhosted  | Error: request to https://binaries.prisma.sh/all_commits/473ed3124229e22d881cb7addf559799debae1ab/debian-openssl-3.0.x/schema-engine.sha256 failed, reason:
affine_selfhosted  | error Command failed with exit code 1.
affine_selfhosted  | info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
affine_selfhosted  | error Command failed with exit code 1.
affine_selfhosted  | info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
affine_selfhosted  | node:internal/errors:984
affine_selfhosted  |   const err = new Error(message);
affine_selfhosted  |               ^
affine_selfhosted  |
affine_selfhosted  | Error: Command failed: yarn predeploy
affine_selfhosted  |     at genericNodeError (node:internal/errors:984:15)
affine_selfhosted  |     at wrappedFn (node:internal/errors:538:14)
affine_selfhosted  |     at checkExecSyncError (node:child_process:890:11)
affine_selfhosted  |     at execSync (node:child_process:962:15)
affine_selfhosted  |     at runPredeployScript (file:///app/scripts/self-host-predeploy.js:67:3)
affine_selfhosted  |     at file:///app/scripts/self-host-predeploy.js:75:1
affine_selfhosted  |     at ModuleJob.run (node:internal/modules/esm/module_job:222:25)
affine_selfhosted  |     at async ModuleLoader.import (node:internal/modules/esm/loader:323:24)
affine_selfhosted  |     at async loadESM (node:internal/process/esm_loader:28:7)
affine_selfhosted  |     at async handleMainPromise (node:internal/modules/run_main:113:12) {
affine_selfhosted  |   status: 1,
affine_selfhosted  |   signal: null,
affine_selfhosted  |   output: [ null, null, null ],
affine_selfhosted  |   pid: 20,
affine_selfhosted  |   stdout: null,
affine_selfhosted  |   stderr: null
affine_selfhosted  | }
affine_selfhosted  |
affine_selfhosted  | Node.js v20.12.2
affine_selfhosted exited with code 0```

Could I get any help with this or recovering my previous data/notes?

Thanks so much! 

[darkskygit]

please check your network, when the container start first time, the container need to download some necessary dependencies on the Internet

[zkwolf]

add environment to docker-compose.yml PRISMA_ENGINES_MIRROR=https://registry.npmmirror.com/-/binary/prisma

[IEatCodeDaily]

The affine file is used in the desktop app, but since selfhost currently cannot use the desktop app, you cannot export the selfhost workspace as an affine file. But we expect to support selfhost using desktop app in the summer, so you'll be able to do this.

any update on self-hosted affine on desktop app?
I'm considering moving from AnyType to Affine but not being able to use desktop app is quite a huge minus

[bomberstudios]

I'm trying to change my user avatar in a self-hosted instance (using stable) and while it shows me a 'success' message when uploading the new avatar, it does not change in the web app.

What am I doing wrong?

Thanks in advance, and kudos for the self-host effort. I want to use AFFiNE for my family, and not having to depend on an external service is really awesome.

[bomberstudios]

Nice! Will do and report back.

[bomberstudios]

I updated the custom options, but for some reason the app is ignoring the port:

[EYHN]

How did you configure it? The port should be another variable

[bomberstudios]

I am configuring the port everywhere I've seen it 😅

This is the command I use to launch Docker:

// This is on a git checkout of the `canary` branch:
AFFINE_SERVER_HOST=3020.local AFFINE_SERVER_PORT=3010 [email protected] AFFINE_ADMIN_PASSWORD="affine" docker compose -f ./.github/deployment/self-host/compose.yaml up --detach

This is the content of the files on my $HOME/.affine/selt-host/config/ folder:

//.env
AFFINE_SERVER_PORT=3010
AFFINE_SERVER_HOST=3020.local
AFFINE_SERVER_HTTPS=false
# DATABASE_URL="postgres://affine@localhost:5432/affine"

// affine.js
AFFiNE.https = false;
AFFiNE.host = '3020.local';
AFFiNE.port = 3010;

I know I only need to specify this stuff in one place, not all, but I did not want to take any chances 😂

In any case: image uploads don't seem to work (as another user mentioned in other comment) and I can't change the avatar for my user or the icon for a workspace. Feels like all of these might be related...

[chaoticgood1]

I confirm changing the AFFINE_SERVER_PORT=3001 and AFFINE_SERVER_HTTPS=true is not working on my end too. Is there something more we have to do to make this work? Thanks.

[zkwolf]

1. I think blocksuite should provide a way to change the default imageProxy middleware in import-doc.
   Now AFFINE use the blocksuite func with https://affine-worker.toeverything.workers.dev to proxy image，the self-hosted version should be banned by CORS.
2. About imageProxy and linkPreview worker
   AFFINE use /api/worker prefix to fetch workers but in self-hosted version there is no implement. However reverse proxy is a way to get this work. I think AFFINE can open source these workers and users can deploy this on their Cloudflare account.

[EYHN]

@darkskygit @forehalo take a look

[darkskygit]

1. we will support customization of image proxy and link preview endpoint in the next version
2. we have open sourced it here: https://github.com/toeverything/affine-workers

[zkwolf]

It seems that this repo only contains link-preview worker.

[darkskygit]

we have update the worker repos

[TomasJack1]

1. I use self-host cloudflare worker and nginx reverse proxy，successfully solve link-preview and image-proxy problem，detail is in my article written in chinese.
2. 我使用自部署Cloudflare Worker和Nginx反向代理解决了link-preview和image-proxy问题，具体可看我的文章。
3. Address 地址：https://app.affine.pro/share/c420579d-b56a-45f3-9ba7-c47e787e7077/uQo_1uog_I2fqQ5XIw7Eb

[patrick-men]

I deployed AFFiNE with your docker compose image, and it works fine with currently one main issue: I can't upload images. Pasting screenshots doesn't do anything, and importing images with /image results in an error stating either failed to upload image! crypto.subtle is undefined or just a Image loading failed. This happens on every browser I tested so far, and I haven't managed to get any pictures into my notes. I've tried both .png and .jpg/.jpeg

Other than that, awesome app you guys made! Most everything has worked pretty well so far

[darkskygit]

same as #6049

[YourDaniel]

Is there a method to add new users without configuring mailer service? For example, via adding users directly to the database?

[EYHN]

#5957

[YourDaniel]

Thanks. But now how do you add users to your workspace? I added a bunch of users, they can login no problem. But only option to add them to workspace for shared work is via option "Invite members". But that requires configured mailer service. Is there a method to add a user to specific workspace?

[alissa-tung]

seems that

#5946 (comment)

AFFiNE/packages/backend/server/src/core/workspaces/resolvers/workspace.ts

Line 322 in a721b38

async invite(

[YourDaniel]

Thank you, that helped!

[aliuq]

Hi，Whether the self-host version is subject to free plan restrictions, such as size and members

[darkskygit]

this is an impl mistake, please pay attention to the progress of #6156

[ylbeethoven]

Hi, thanks for providing the self-hosted option. I was wondering if there is an option to disable /onboarding page and Demo Workspace. I want to lock down my instance with just a log in page.

Thank you.

[darkskygit]

please follow #6141

[brentonmallen1]

I was also hoping to be able to disable the demo workspace entirely. meaning, when you go to the page you're forced to sign in instead of being greeted with a local/demo workspace. The linked issue doesn't address this, it's about disabling signups. Is it possible to disable the demo workspace entirely?

[HeJiachen-PM]

Could you please share more about your use case when disabling the demo workspace is demanded?

[Dayonixe]

Hello,
When I follow the procedure to install AFFiNE locally, I get the following problem:

affine_selfhosted  | [Nest] 135  - 03/15/2024, 6:39:50 PM     LOG [RunCommand] Running SelfHostAdmin1605053000403...
affine_selfhosted  | [Nest] 135  - 03/15/2024, 6:39:50 PM   ERROR [RunCommand] Failed to run data migration
affine_selfhosted  | [Nest] 135  - 03/15/2024, 6:39:50 PM   ERROR [RunCommand] PrismaClientKnownRequestError:
affine_selfhosted  | Invalid `prisma.user.create()` invocation:
affine_selfhosted  |
affine_selfhosted  |
affine_selfhosted  | An operation failed because it depends on one or more records that were required but not found. No 'Features' record(s) (needed to inline the relation on 'UserFeatures' record(s)) was found for a nested connect on one-to-many relation 'FeaturesToUserFeatures'.
affine_selfhosted  | error Command failed with exit code 1.
affine_selfhosted  | info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
affine_selfhosted  | node:internal/errors:932
affine_selfhosted  |   const err = new Error(message);
affine_selfhosted  |               ^
affine_selfhosted  |
affine_selfhosted  | Error: Command failed: yarn predeploy
affine_selfhosted  |     at checkExecSyncError (node:child_process:890:11)
affine_selfhosted  |     at execSync (node:child_process:962:15)
affine_selfhosted  |     at runPredeployScript (file:///app/scripts/self-host-predeploy.js:44:3)
affine_selfhosted  |     at file:///app/scripts/self-host-predeploy.js:52:1
affine_selfhosted  |     at ModuleJob.run (node:internal/modules/esm/module_job:218:25)
affine_selfhosted  |     at async ModuleLoader.import (node:internal/modules/esm/loader:329:24)
affine_selfhosted  |     at async loadESM (node:internal/process/esm_loader:28:7)
affine_selfhosted  |     at async handleMainPromise (node:internal/modules/run_main:113:12) {
affine_selfhosted  |   status: 1,
affine_selfhosted  |   signal: null,
affine_selfhosted  |   output: [ null, null, null ],
affine_selfhosted  |   pid: 20,
affine_selfhosted  |   stdout: null,
affine_selfhosted  |   stderr: null
affine_selfhosted  | }
affine_selfhosted  |
affine_selfhosted  | Node.js v20.11.1
affine_selfhosted exited with code 0

Full logs: logs.log

[EYHN]

please use the image tag with stable-cccea3e , until we fix this

[Dayonixe]

It works, thank you so much 🙏

[ylbeethoven]

Another question is how do I manage tags? Let's say I want to modify existing tags, I can't seem to find any settings to delete/edit tags.

[EYHN]

Make sure you are in 0.13.0. On the all doc page, there is a tags button at the top.
Click the button, and you can manage all tags, including deletion and modification.

[ylbeethoven]

@EYHN Thank you. 0.13.0 solves this issue.

[RandomLegend]

It appears as if the latest stable image still doesn't let you login; We still have to use stable-cccea3e ?

Also, why would you have a cloudflare check on my selfhosted install?

[RandomLegend]

What exactly do you mean with the default key should always pass? Is this in regards to my statement that i can't login?

If i use the ADMIN mail and ADMIN Password i just get a red border around the password field when trying to log in; This is after that cloudflare check.

I'm on arch and just updated everything; I use Thorium browser which is up to date.

[darkskygit]

default key means the secret key of cloudflare captcha, self hosted version now using this key by default -- the relevant modules will be disabled in the next major version of self-hosted
if there has a red border around the password field, it means that the password you entered does not comply with the default password security rules -- this may be a bug, I will check it tomorrow

[RandomLegend]

What exactly are the default password security rules?

I can't find them anywhere

[darkskygit]

length >= 8

[RandomLegend]

yeah then this is a bug.

i have 1 capital, 1 lowercase, 1 number, 1 special and more than 8 but not more than 20

[ovizii]

Is there a summary/status about self-hosting affine behind a reverse proxy?
###edit###
I tested it and it just works.

[Vinetos]

Hey!
Can you share details about how you done that ? I am trying to deploy affine behind a reverse proxy to enable HTTPS and custom domain but I did not make it work for now.
Thanks

[ovizii]

Any particular reason why the password is capped at 20 characters for the self-hosted version?

Also, I noticed that when the onboarding pages are displayed, I can click the titles, I can go to the next one, but I cannot scroll with the mouse wheel.

[darkskygit]

we use argon2 as the password hashing algorithm, length = 20 is enough to prevent your password from being cracked in a meaningful time: https://datatracker.ietf.org/doc/html/rfc9106

[ovizii]

Thx, I know, I was simply wondering why put a cap on a password length at all. Anyway, no big deal. I only noticed this issue as I had changed my password manager from using passwords to passphrases and set it to 6 words, so I went over 20 characters.

[EYHN]

I think we should review this limit, 20 characters seems too short, github is 72 characters, 1password is able to create up to 64 characters

[forehalo]

it will be able to customize the min/max length of password in selfhost server soon

[yogg-soggot]

Hi! Can you please hint me how do I enable https? I tried using certbot, but it doesn't work somehow.
Do I need to sutup it in docker?

[darkskygit]

In addition to managing https certificates yourself, you need to provide an environment variable to the affine container AFFINE_SERVER_HTTPS=true

[BadboyXiaobai]

In addition to managing https certificates yourself, you need to provide an environment variable to the affine container AFFINE_SERVER_HTTPS=true

Can you explain more details? Or is there a complete tutorial on how to set up a CA certificate? I used the BT panel to create a website and set up a reverse proxy to access affine and set up a website certificate. I can access it through https and copy other functions. But there is a problem with synchronization. It may be because the CA certificate is not set up in affine, which leads to content decryption problems.

[darkskygit]

The AFFiNE server does not include any HTTPS response logic.

Please use Caddy or Cloudflare Tunnel to automatically configure HTTPS certificates, or use Caddy or Nginx to configure HTTPS certificates manually.

[Ynsnnn]

This is how I access the application: https://my.domain.com/affine. But it redirects me to https://my.domain.com/js/npm... (for example) and I need https://my.domain.com/affine/js/npm...
I put AFFINE_SERVER_EXTERNAL_URL="https://my.domain.com/affine/" and AFFINE_SERVER_SUB_PATH="/affine/" and it still doesn't work. What env variables should I configure or what am I doing wrong?

[darkskygit]

currently, we do not support deploying affine to subpaths
moreover, hosting multiple web applications on the same domain will allow these web applications to read and write each other's saved data, which may lead to data corruption in affine's workspace data stored in the browser
we recommend using a separate domain for deploying affine

[SimonaCatanoiu]

would you consider adding this feature?

[darkskygit]

currently no plans for this feature

[dkavraal]

@darkskygit check nginx path rewrite. you may get result from putting it behind a reverse proxy.

[linkh2010]

Hi, Is backing up the postgresql 'affine' database enough to keep my notes safe?

[chandr-andr]

From my experience yes, I disabled redis as a dependency in my chart and everything https://github.com/chandr-andr/affine-chart/blob/main/charts/affine/values.yaml works perfect

[peaklabs-dev]

I am developing a one click deploy template for Coolify (link). What is the port mapping 5555:5555 for? Can I safely remove this if I am using a reverse proxy as I can also remove 3010 with the proxy it would be great if I can remove this as well?

[mfreeman451]

did you ever get the coolify stuff working?

[fallsdevil]

Ask your questions about selfhost AFFiNE here

Hi, I just found this software, I would like to know two things before downloading it and testing it: I wanted to know if there is the possibility of making mind maps by drawing on the board, because the examples I saw didn't have it and that's what I'm looking for. Another question, would a smartphone app be possible in the near future?

[HeJiachen-PM]

Yes, we have mindmap support and yes, a mobile version is coming Gabriel ***@***.***>于2024年11月23日 周六07:08写道：

…

Ask your questions about selfhost AFFiNE here Hi, I just found this software, I would like to know two things before downloading it and testing it: I wanted to know if there is the possibility of making mind maps by drawing on the board, because the examples I saw didn't have it and that's what I'm looking for. Another question, would a smartphone app be possible in the near future? — Reply to this email directly, view it on GitHub <#5975 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AS5AYR53G3SJOISVO6IOM5D2B62PBAVCNFSM6AAAAABEBDLRGOVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTCMZVGQYDGOI> . You are receiving this because you commented.Message ID: ***@***.***>

[al-lac]

How can i find the right package version for a release?

So for example i assumed that for v0.18.1 this would be the right container / package as it has the "stable" tag. But open installing it turned out to be a v0.18.0-canary build.

https://github.com/toeverything/AFFiNE/pkgs/container/affine-graphql/310241297?tag=stable

[al-lac]

Ok, found out that it usually should be the "stable" tag and finding a specific release can be done by using the short commit id. Would still be helpful if the packages were tagged with something like "v0.18.1".

[Niraj-Dilshan]

Self hosted version why showing free tier can some one explain have i done something wrong

[skarchmit]

Mine shows 100gb, but I know I have at least 400 gb locally before I am going to link my nas instead. I'm not sure why it's limited to 100 GB or how to increase. If I'm limited locally, whats the point of this app?

[tinybitsofcode]

Hello, for the self-hosted version, I noticed the app still tries to post logs to Sentry (https://o291318.ingest.sentry.io/api/4506307500179456/envelope/?sentry_version=7&sentry_key=8785a2546e570310b8e09957d218b1aa&sentry_client=sentry.javascript.react%2F8.47.0) - could that functionality be removed or allowed for us to provide our own Sentry instance?

[Cironic]

Is there the possibility to host the image on https://hub.docker.com/ aswell?

[darkskygit]

currently no plans to migrate to docker hub

[vandermark1977]

I have just installed Affine as docker, following Mariushosting tutorial and it works great. I really love the app. I have used it for some work related brainstorm sessions and it was great. I cannot install the Affine app on my work desktop but the webapp through a https reverse proxy works great. I have one question/request:

How can i turn off the standard functionality where everybody can start writing/drawing on a 'local demo workspace'? I don't want that since colleagues which I share some results can see the server URL.

I just want a login screen when someone enters my URL https://affine.myserver.com

[masterhinz]

i would love to do this, too

[dehuszar]

Is there a way to sync data between self-hosted and cloud versions? I would love to get started with the cloud version just to try stuff out, but eventually switch over to self-hosted.

[dxkrs]

Self-host is deployed in an Internet-accessed local area network. How can manually created accounts invite other accounts in self-host to the workspace? At present, it is seen that the invitation depends on email sending. Is it necessary to build a complete email service in the local area network?

[JoQCcoz]

I have the same problem. There must be a way to go in the database and add the necessary entries if nothing else.

[dxkrs]

I have the same problem. There must be a way to go in the database and add the necessary entries if nothing else.

I have found a method : open the developer tool of the web page, then open the invitation list, then find the invite_id in the developer tool, and then assemble and access the url: {host_url}/invite/{invite_id}

[floli]

Hey,

how can I change the language of OpenAI ChatGPT integration? I have enabled the integration using

AFFiNE.use('copilot', {
  openai: {
    apiKey: process.env.COPILOT_OPENAI_API_KEY,
  },
})

The UI language is German, but the AI operates in English. How can I change it?

Thanks!

[HeJiachen-PM]

You are not limited to local storage with clients. If you see the cloud limit, that's just to align the limit from our hosted cloud. You can remove the storage limit yourself Serge Karchmit ***@***.***> 於 2025年4月1日 週二 下午3:17寫道：

…

Mine shows 100gb, but I know I have at least 400 gb locally before I am going to link my nas instead. I'm not sure why it's limited to 100 GB or how to increase. If I'm limited locally, whats the point of this app? — Reply to this email directly, view it on GitHub <#5975 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AS5AYR4MRJAZJAB6RLK4C6D2XMF6PAVCNFSM6AAAAABEBDLRGOVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTENRZGM3TMNQ> . You are receiving this because you commented.Message ID: ***@***.***>