[GH-ISSUE #13] [Question] Any plans for a Docker image? #5

Closed
opened 2026-03-23 20:30:10 +00:00 by mirror · 36 comments
Owner

Originally created by @sfkpmr on GitHub (Nov 16, 2021).
Original GitHub issue: https://github.com/AppFlowy-IO/AppFlowy/issues/13

I see .dockerignore, but no Dockerfile. Would love to see one!

Originally created by @sfkpmr on GitHub (Nov 16, 2021). Original GitHub issue: https://github.com/AppFlowy-IO/AppFlowy/issues/13 I see .dockerignore, but no Dockerfile. Would love to see one!
mirror 2026-03-23 20:30:10 +00:00
Author
Owner

@stemount commented on GitHub (Nov 16, 2021):

@sfkpmr what do you propose the use of Docker for? (building? hosting flutter as a pwa or something - not a flutter expert)

<!-- gh-comment-id:970041994 --> @stemount commented on GitHub (Nov 16, 2021): @sfkpmr what do you propose the use of Docker for? (building? hosting flutter as a pwa or something - not a flutter expert)
Author
Owner

@nicolasdanelon commented on GitHub (Nov 16, 2021):

@sfkpmr maybe I don't want to install Rust on my machine, maybe I just want to download the docker images and run the app on my local environment without installing any dependency...
also docker containers can be used to deploy the app faster on tons of boxes.
if some developer is using M1 and doesn't have a dependency or is just running Linux docker will have all dependencies already built in, configured and ready to run.
Docker is a must

<!-- gh-comment-id:970050719 --> @nicolasdanelon commented on GitHub (Nov 16, 2021): @sfkpmr maybe I don't want to install Rust on my machine, maybe I just want to download the docker images and run the app on my local environment without installing any dependency... also docker containers can be used to deploy the app faster on tons of boxes. if some developer is using M1 and doesn't have a dependency or is just running Linux docker will have all dependencies already built in, configured and ready to run. Docker is a must
Author
Owner

@appflowy commented on GitHub (Nov 16, 2021):

@sfkpmr The docker file is used to deploy the AppFlowy backend on the local host.

<!-- gh-comment-id:970057700 --> @appflowy commented on GitHub (Nov 16, 2021): @sfkpmr The docker file is used to deploy the AppFlowy backend on the local host.
Author
Owner

@franciscoafonsoo commented on GitHub (Nov 16, 2021):

Would you guys be open to a Pull Request for a docker-compose and some Dockerfiles ?

I was thinking that it would help local development in the wild to have a docker-compose that launches the db, the backend and the frontend (never dockerized a flutter app but should be possible).

Edit: i'm checking the database scripts. The idea would be to simplify this logic so that random developers can launch the project in a very simple and straight forward way

<!-- gh-comment-id:970208255 --> @franciscoafonsoo commented on GitHub (Nov 16, 2021): Would you guys be open to a Pull Request for a docker-compose and some Dockerfiles ? I was thinking that it would help local development in the wild to have a docker-compose that launches the db, the backend and the frontend (never dockerized a flutter app but should be possible). Edit: i'm checking the database scripts. The idea would be to simplify this logic so that random developers can launch the project in a very simple and straight forward way
Author
Owner

@PabloCastellano commented on GitHub (Nov 16, 2021):

Yes, please! The Rust+Flutter stack isn't that common nowadays and having to spend more than 1 hour (my case so far) for installing all the Rust and Flutter dependencies, plus compiling... is discouraging, unless you have been waiting for a Notion open source clone for years!

With Docker it would be super easy and fast to just fetch AppFlowy and run it

<!-- gh-comment-id:970233569 --> @PabloCastellano commented on GitHub (Nov 16, 2021): Yes, please! The Rust+Flutter stack isn't that common nowadays and having to spend more than 1 hour (my case so far) for installing all the Rust and Flutter dependencies, plus compiling... is discouraging, unless you have been waiting for a Notion open source clone for years! With Docker it would be super easy and fast to just fetch AppFlowy and run it
Author
Owner

@ghost commented on GitHub (Nov 16, 2021):

Please DO create the Docker Image we are interested in hosting it on our servers.

<!-- gh-comment-id:970328254 --> @ghost commented on GitHub (Nov 16, 2021): Please DO create the Docker Image we are interested in hosting it on our servers.
Author
Owner

@huangxinping commented on GitHub (Nov 16, 2021):

Please DO create the Docker Image we are also VERY interested.

It has taken more than 3 hours to install all dependencies so far without success.

<!-- gh-comment-id:970364705 --> @huangxinping commented on GitHub (Nov 16, 2021): Please DO create the Docker Image we are also VERY interested. It has taken more than 3 hours to install all dependencies so far without success.
Author
Owner

@annieappflowy commented on GitHub (Nov 16, 2021):

Would you guys be open to a Pull Request for a docker-compose and some Dockerfiles ?

I was thinking that it would help local development in the wild to have a docker-compose that launches the db, the backend and the frontend (never dockerized a flutter app but should be possible).

Edit: i'm checking the database scripts. The idea would be to simplify this logic so that random developers can launch the project in a very simple and straight forward way

We're definitely open to PRs. To understand this better, do you want a docker backend or both the backend and the frontend?

<!-- gh-comment-id:970368473 --> @annieappflowy commented on GitHub (Nov 16, 2021): > Would you guys be open to a Pull Request for a docker-compose and some Dockerfiles ? > > I was thinking that it would help local development in the wild to have a docker-compose that launches the db, the backend and the frontend (never dockerized a flutter app but should be possible). > > Edit: i'm checking the database scripts. The idea would be to simplify this logic so that random developers can launch the project in a very simple and straight forward way We're definitely open to PRs. To understand this better, do you want a docker backend or both the backend and the frontend?
Author
Owner

@annieappflowy commented on GitHub (Nov 16, 2021):

Yes, please! The Rust+Flutter stack isn't that common nowadays and having to spend more than 1 hour (my case so far) for installing all the Rust and Flutter dependencies, plus compiling... is discouraging, unless you have been waiting for a Notion open source clone for years!

With Docker it would be super easy and fast to just fetch AppFlowy and run it

Love how you put this all together - I can feel your pain now :(
Let's just keep discussing this topic in this thread until we land on a nice solution :D

<!-- gh-comment-id:970371312 --> @annieappflowy commented on GitHub (Nov 16, 2021): > Yes, please! The Rust+Flutter stack isn't that common nowadays and having to spend more than 1 hour (my case so far) for installing all the Rust and Flutter dependencies, plus compiling... is discouraging, unless you have been waiting for a Notion open source clone for years! > > With Docker it would be super easy and fast to just fetch AppFlowy and run it Love how you put this all together - I can feel your pain now :( Let's just keep discussing this topic in this thread until we land on a nice solution :D
Author
Owner

@sfkpmr commented on GitHub (Nov 16, 2021):

@annieappflowy An image for both would be awesome!

<!-- gh-comment-id:970372826 --> @sfkpmr commented on GitHub (Nov 16, 2021): @annieappflowy An image for both would be awesome!
Author
Owner

@annieappflowy commented on GitHub (Nov 16, 2021):

Please DO create the Docker Image we are also VERY interested.

It has taken more than 3 hours to install all dependencies so far without success.

Please join our Discord channel, and I believe some pro hackers can help you out there

<!-- gh-comment-id:970374114 --> @annieappflowy commented on GitHub (Nov 16, 2021): > Please DO create the Docker Image we are also VERY interested. > > It has taken more than 3 hours to install all dependencies so far without success. Please join our Discord channel, and I believe some pro hackers can help you out there
Author
Owner

@appflowy commented on GitHub (Nov 16, 2021):

@franciscoafonsoo It seems possible to docker the flutter desktop application.
https://hub.docker.com/r/openpriv/flutter-desktop

I use docker to host the backend on my laptop to develop the frontend, but I didn't set up the Dockerfile.

<!-- gh-comment-id:970374649 --> @appflowy commented on GitHub (Nov 16, 2021): @franciscoafonsoo It seems possible to docker the flutter desktop application. https://hub.docker.com/r/openpriv/flutter-desktop I use docker to host the backend on my laptop to develop the frontend, but I didn't set up the Dockerfile.
Author
Owner

@appflowy commented on GitHub (Nov 16, 2021):

Guys, PRs for this are welcomed :D

<!-- gh-comment-id:970379999 --> @appflowy commented on GitHub (Nov 16, 2021): Guys, PRs for this are welcomed :D
Author
Owner

@i-iooi-i commented on GitHub (Nov 16, 2021):

Yes, docker is very needed to run it

<!-- gh-comment-id:970394693 --> @i-iooi-i commented on GitHub (Nov 16, 2021): Yes, docker is very needed to run it
Author
Owner

@franciscoafonsoo commented on GitHub (Nov 16, 2021):

@franciscoafonsoo It seems possible to docker the flutter desktop application. https://hub.docker.com/r/openpriv/flutter-desktop

I use docker to host the backend on my laptop to develop the frontend, but I didn't set up the Dockerfile.

I will then join discord and discuss some things !

<!-- gh-comment-id:970487813 --> @franciscoafonsoo commented on GitHub (Nov 16, 2021): > @franciscoafonsoo It seems possible to docker the flutter desktop application. https://hub.docker.com/r/openpriv/flutter-desktop > > I use docker to host the backend on my laptop to develop the frontend, but I didn't set up the Dockerfile. I will then join discord and discuss some things !
Author
Owner

@franciscoafonsoo commented on GitHub (Nov 16, 2021):

So i will start with something very simple:

  • docker-compose definition for the backend and the database. something like this
version: "3.8"

services:
  backend:
    image: appflowy-backend
    build:
      context: ./backend
      dockerfile: Dockerfile

    ports:
      - 8080:8080

  database:
    image: postgres:14.1-bullseye
    environment:
      DB_USER: postgres
      DB_PASSWORD: password
      DB_NAME: flowy
      DB_PORT: 5433

    ports:
      - 5433:5433

I am reading the db scripts to understand what needs to be done. But should look something like that. After having that done, it's a matter of exploring flutter docker and connecting it.

Is the existing rust Dockerfile working ? @appflowy

<!-- gh-comment-id:970502185 --> @franciscoafonsoo commented on GitHub (Nov 16, 2021): So i will start with something very simple: - docker-compose definition for the backend and the database. something like this ```yaml version: "3.8" services: backend: image: appflowy-backend build: context: ./backend dockerfile: Dockerfile ports: - 8080:8080 database: image: postgres:14.1-bullseye environment: DB_USER: postgres DB_PASSWORD: password DB_NAME: flowy DB_PORT: 5433 ports: - 5433:5433 ``` I am reading the db scripts to understand what needs to be done. But should look something like that. After having that done, it's a matter of exploring flutter docker and connecting it. Is the existing rust Dockerfile working ? @appflowy
Author
Owner

@esturniolo commented on GitHub (Nov 17, 2021):

+1 for this

<!-- gh-comment-id:971095346 --> @esturniolo commented on GitHub (Nov 17, 2021): +1 for this
Author
Owner

@appflowy commented on GitHub (Nov 17, 2021):

@franciscoafonsoo Wow, it seems ok to me. Have you tried it?

  • The existing Dockerfile does not work anymore.
<!-- gh-comment-id:971125640 --> @appflowy commented on GitHub (Nov 17, 2021): @franciscoafonsoo Wow, it seems ok to me. Have you tried it? * The existing Dockerfile does not work anymore.
Author
Owner

@HawksRepos commented on GitHub (Nov 17, 2021):

another +1 for this!! a docker container would make it that much easier to set up and run on any server

<!-- gh-comment-id:972151820 --> @HawksRepos commented on GitHub (Nov 17, 2021): another +1 for this!! a docker container would make it that much easier to set up and run on any server
Author
Owner

@adamzhoul commented on GitHub (Nov 18, 2021):

+1

little idea, let's volume data to the local.
so we can easily back up.
or, users can volume path to apple iCloud path, so data can sync between the company and home easily.

by the way, don't forget to support M1. 😁

<!-- gh-comment-id:972976486 --> @adamzhoul commented on GitHub (Nov 18, 2021): +1 little idea, let's volume data to the local. so we can easily back up. or, users can volume path to apple iCloud path, so data can sync between the company and home easily. by the way, don't forget to support M1. 😁
Author
Owner

@pramadito commented on GitHub (Nov 19, 2021):

+1

i would love to develop full stack with docker

<!-- gh-comment-id:973778900 --> @pramadito commented on GitHub (Nov 19, 2021): +1 i would love to develop full stack with docker
Author
Owner

@juangburgos commented on GitHub (Nov 19, 2021):

+1

<!-- gh-comment-id:974065073 --> @juangburgos commented on GitHub (Nov 19, 2021): +1
Author
Owner

@polypixeldev commented on GitHub (Nov 19, 2021):

+1
Is there a PR in progress for this?

<!-- gh-comment-id:974507543 --> @polypixeldev commented on GitHub (Nov 19, 2021): +1 Is there a PR in progress for this?
Author
Owner

@tborychowski commented on GitHub (Nov 25, 2021):

There's a whole community of self-hosters who would love to take this for a spin! :-D

<!-- gh-comment-id:979320131 --> @tborychowski commented on GitHub (Nov 25, 2021): There's a whole community of [self-hosters](https://www.reddit.com/r/selfhosted/) who would love to take this for a spin! :-D
Author
Owner

@HawksRepos commented on GitHub (Nov 25, 2021):

Yeah we would be keen to do a video on this if we could get a working docker container running on the unraid platform (we can add the template on your behalf if needed) - https://youtube.com/c/IBRACORP

<!-- gh-comment-id:979321965 --> @HawksRepos commented on GitHub (Nov 25, 2021): Yeah we would be keen to do a video on this if we could get a working docker container running on the unraid platform (we can add the template on your behalf if needed) - https://youtube.com/c/IBRACORP
Author
Owner

@felipefideli commented on GitHub (Nov 28, 2021):

+1

<!-- gh-comment-id:980812351 --> @felipefideli commented on GitHub (Nov 28, 2021): +1
Author
Owner

@armin771 commented on GitHub (Nov 28, 2021):

Yeah we would be keen to do a video on this if we could get a working docker container running on the unraid platform (we can add the template on your behalf if needed) - https://youtube.com/c/IBRACORP

That would be fantastic. Would love to get it running on my end under unraid.

<!-- gh-comment-id:981058141 --> @armin771 commented on GitHub (Nov 28, 2021): > Yeah we would be keen to do a video on this if we could get a working docker container running on the unraid platform (we can add the template on your behalf if needed) - https://youtube.com/c/IBRACORP That would be fantastic. Would love to get it running on my end under unraid.
Author
Owner

@0xN0x commented on GitHub (Dec 1, 2021):

+1

<!-- gh-comment-id:983632545 --> @0xN0x commented on GitHub (Dec 1, 2021): +1
Author
Owner

@lirc572 commented on GitHub (Dec 3, 2021):

I think it would be more useful to be able to also run the flutter desktop app itself in a docker container during development and display the GUI on the host machine, because it will allow us to use flutter's hot reload for development.

This link is a good reference on how to run GUI apps in a container. Not sure if it will be easy to apply it to the flutter desktop toolchain though.

A web (PWA) version would of course be much easier to run/develop with docker.

<!-- gh-comment-id:985710664 --> @lirc572 commented on GitHub (Dec 3, 2021): I think it would be more useful to be able to also run the flutter desktop app itself in a docker container during development and display the GUI on the host machine, because it will allow us to use flutter's hot reload for development. [This link](http://wiki.ros.org/docker/Tutorials/GUI) is a good reference on how to run GUI apps in a container. Not sure if it will be easy to apply it to the flutter desktop toolchain though. A web (PWA) version would of course be much easier to run/develop with docker.
Author
Owner

@appflowy commented on GitHub (Dec 5, 2021):

The backend docker image is ready. Run
make docker_image

image

image

I couldn't find the method to run the GUI desktop application build with flutter in Docker, but I'll keep trying. I'm working on the frontend part that enables communication with the backend. Let me know if I'm on the right track to meet your needs.

<!-- gh-comment-id:986191159 --> @appflowy commented on GitHub (Dec 5, 2021): The backend docker image is ready. Run `make docker_image` ![image](https://user-images.githubusercontent.com/86001920/144740064-ff2c4539-a139-4bf6-afe6-4c65c6bc6f33.png) ![image](https://user-images.githubusercontent.com/86001920/144740228-95f5e90c-996f-44cb-b4c6-d1c9f63151d7.png) I couldn't find the method to run the GUI desktop application build with flutter in Docker, but I'll keep trying. I'm working on the frontend part that enables communication with the backend. Let me know if I'm on the right track to meet your needs.
Author
Owner

@irfanbacker commented on GitHub (Dec 6, 2021):

I couldn't find the method to run the GUI desktop application build with flutter in Docker, but I'll keep trying. I'm working on the frontend part that enables communication with the backend. Let me know if I'm on the right track to meet your needs.

I don't think there is a straightforward way to do it. Users might have to do some external setup to get GUI applications working on docker. Besides, i don't think there is a usecase here. Users could easily use the release zips to run the frontend. If its for easier building, maybe a docker image with mounted folder could be used and the build could be output in the folder.

<!-- gh-comment-id:986750246 --> @irfanbacker commented on GitHub (Dec 6, 2021): > I couldn't find the method to run the GUI desktop application build with flutter in Docker, but I'll keep trying. I'm working on the frontend part that enables communication with the backend. Let me know if I'm on the right track to meet your needs. I don't think there is a straightforward way to do it. Users might have to do some external setup to get GUI applications working on docker. Besides, i don't think there is a usecase here. Users could easily use the release zips to run the frontend. If its for easier building, maybe a docker image with mounted folder could be used and the build could be output in the folder.
Author
Owner

@antoineozenne commented on GitHub (Dec 10, 2021):

I think a docker-compose to launch all the stack (back, front, db) would be great to promote the application. Today, I wanted to test the application on Ubuntu, but there is no "one-command test". In addition, Rust and Flutter are still fairly new, and not everyone is perfectly comfortable with these technologies. While a docker-compose...

<!-- gh-comment-id:990778881 --> @antoineozenne commented on GitHub (Dec 10, 2021): I think a docker-compose to launch all the stack (back, front, db) would be great to promote the application. Today, I wanted to test the application on Ubuntu, but there is no "one-command test". In addition, Rust and Flutter are still fairly new, and not everyone is perfectly comfortable with these technologies. While a docker-compose...
Author
Owner

@MikeWallaceDev commented on GitHub (Dec 13, 2021):

This thread needs a conclusion. There seems to be bits and pieces, but no clear outcome. Can someone write up a blogpost/wiki that explains what our docker containers can do, how to install them, and how to use them? If a PR is needed, let's get that done too. Then we can close this issue.

Who would like to take the lead on this?

@nicolasdanelon @appflowy @franciscoafonsoo @annieappflowy @adamzhoul @lirc572 @antoineozenne

<!-- gh-comment-id:992894005 --> @MikeWallaceDev commented on GitHub (Dec 13, 2021): This thread needs a conclusion. There seems to be bits and pieces, but no clear outcome. Can someone write up a blogpost/wiki that explains what our docker containers can do, how to install them, and how to use them? If a PR is needed, let's get that done too. Then we can close this issue. Who would like to take the lead on this? @nicolasdanelon @appflowy @franciscoafonsoo @annieappflowy @adamzhoul @lirc572 @antoineozenne
Author
Owner

@armin771 commented on GitHub (Dec 17, 2021):

Would it be possible to make the Docker available on DockerHub? Then it would be easy to set up AppFlowy on Unraid.

<!-- gh-comment-id:996580491 --> @armin771 commented on GitHub (Dec 17, 2021): Would it be possible to make the Docker available on DockerHub? Then it would be easy to set up AppFlowy on Unraid.
Author
Owner

@MikeWallaceDev commented on GitHub (Dec 26, 2021):

Hello,
A Docker file was created and documented by @rushic24, thanks!

You can find install information here.

<!-- gh-comment-id:1001094434 --> @MikeWallaceDev commented on GitHub (Dec 26, 2021): Hello, A Docker file was created and documented by @rushic24, thanks! You can find install information [here](https://github.com/AppFlowy-IO/appflowy/wiki/Installing-with-Docker).
Author
Owner

@JoyceBabu commented on GitHub (Aug 24, 2022):

Hello, A Docker file was created and documented by @rushic24, thanks!

You can find install information here.

The wiki link is redirecting to the GitHub project home page. Is this no longer supported?

Edit: Found the new link here

<!-- gh-comment-id:1225278144 --> @JoyceBabu commented on GitHub (Aug 24, 2022): > Hello, A Docker file was created and documented by @rushic24, thanks! > > You can find install information [here](https://github.com/AppFlowy-IO/appflowy/wiki/Installing-with-Docker). ~The wiki link is redirecting to the GitHub project home page. Is this no longer supported?~ Edit: Found the new link [here](https://github.com/AppFlowy-IO/AppFlowy-Docs/blob/main/essential-documentation/install-appflowy/installation-methods/installing-with-docker.md)
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
AppFlowy-IO/AppFlowy#5
No description provided.