From 4631d8c9206f61beb063491cc37933d3d806e33f Mon Sep 17 00:00:00 2001 From: Abhi Vaidyanatha Date: Tue, 28 Sep 2021 15:20:01 -0700 Subject: [PATCH] Move long filename troubleshooting out of deploy guide (#6518) * Move long filename troubleshooting out of deploy guide * Edit title of troubleshooting message. Signed-off-by: Abhi Vaidyanatha * period. Signed-off-by: Abhi Vaidyanatha Co-authored-by: Abhi Vaidyanatha --- docs/deploying-airbyte/local-deployment.md | 15 +-------------- docs/troubleshooting/on-deploying.md | 12 ++++++++++++ 2 files changed, 13 insertions(+), 14 deletions(-) diff --git a/docs/deploying-airbyte/local-deployment.md b/docs/deploying-airbyte/local-deployment.md index e5a0dd2fa3cb..befe38d15f92 100644 --- a/docs/deploying-airbyte/local-deployment.md +++ b/docs/deploying-airbyte/local-deployment.md @@ -20,20 +20,7 @@ docker-compose up ## Deploy on Windows -We recommend following [this guide](https://docs.docker.com/docker-for-windows/install/) to install Docker on Windows. After installing the WSL 2 backend and Docker you should be able to run containers using Windows PowerShell. Additionally, as we note frequently, you will need `docker-compose` to build Airbyte from source. The suggested guide already installs `docker-compose` on Windows. - -### Handling long filename error -If you are cloning the repo, you might run into a problem where git indicates that certain filenames are too long and it therefore can't create the local file. So if you received this error after cloning the repo, run the following commands in *git bash*: -```bash -cd airbyte -git config core.longpaths true -git reset --hard HEAD -``` -However it's worth pointing out that the `core.longpaths` option is defaulted to false for a reason, so use with caution. This git configuration is only changed within the cloned Airbyte repo, so you won't need to worry about changing this setting for other repositories. Find more details about this issue in [this stack overflow question](https://stackoverflow.com/questions/22575662/filename-too-long-in-git-for-windows). - -Instead of cloning the repo, you can alternatively download the latest Airbyte release [here](https://github.com/airbytehq/airbyte/releases). Unzip the downloaded file, access the unzipped file using PowerShell terminal, and run `docker-compose up`. After this, you should see the Airbyte containers in the Docker application as in the image below. - -![](../.gitbook/assets/airbyte_deploy_windows_docker.png) +We recommend following [this guide](https://docs.docker.com/docker-for-windows/install/) to install Docker on Windows. After installing the WSL 2 backend and Docker you should be able to run containers using Windows PowerShell. Additionally, as we note frequently, you will need `docker-compose` to build Airbyte from source. The suggested guide already installs `docker-compose` on Windows. ## Troubleshooting diff --git a/docs/troubleshooting/on-deploying.md b/docs/troubleshooting/on-deploying.md index 33c807636cf9..ae6842893fd0 100644 --- a/docs/troubleshooting/on-deploying.md +++ b/docs/troubleshooting/on-deploying.md @@ -13,6 +13,18 @@ Assuming that you are running Airbyte by running `docker-compose up`, then what that should handle you getting reset to the beginning. I would be curious if we can see the logs associated with the failure you are seeing. I would say if after you reset you run into it again we can debug that. +## Git says file names are too long. +If you are cloning the repo, you might run into a problem where git indicates that certain filenames are too long and it therefore can't create the local file. So if you received this error after cloning the repo, run the following commands in *git bash*: +```bash +cd airbyte +git config core.longpaths true +git reset --hard HEAD +``` +However it's worth pointing out that the `core.longpaths` option is defaulted to false for a reason, so use with caution. This git configuration is only changed within the cloned Airbyte repo, so you won't need to worry about changing this setting for other repositories. Find more details about this issue in [this stack overflow question](https://stackoverflow.com/questions/22575662/filename-too-long-in-git-for-windows). + +Instead of cloning the repo, you can alternatively download the latest Airbyte release [here](https://github.com/airbytehq/airbyte/releases). Unzip the downloaded file, access the unzipped file using PowerShell terminal, and run `docker-compose up`. After this, you should see the Airbyte containers in the Docker application as in the image below. + +![](../.gitbook/assets/airbyte_deploy_windows_docker.png) ## I have run `docker-compose up` and can not access the interface