From 4abab16b250637c4f6ba97bf8f7f76f8f9ffcd3a Mon Sep 17 00:00:00 2001
From: Laura Hausmann <laura@hausmann.dev>
Date: Wed, 8 Nov 2023 15:59:52 +0100
Subject: [PATCH] [docs] Add git-lfs disclaimers

---
 docs/docker-compose-install.md | 10 +++++++++-
 docs/install.md                |  8 ++++++++
 2 files changed, 17 insertions(+), 1 deletion(-)

diff --git a/docs/docker-compose-install.md b/docs/docker-compose-install.md
index 79648e941..7d532cf08 100644
--- a/docs/docker-compose-install.md
+++ b/docs/docker-compose-install.md
@@ -6,7 +6,15 @@ This guide is based on `docker compose`/Docker Compose v2, but `docker-compose`/
 
 ### Getting needed files
 
-Run `git clone https://iceshrimp.dev/iceshrimp/iceshrimp`, but if you are not planning on building your own image, just grabbing `.config` and `docs/examples/docker-compose.yml` from the repo will suffice.
+If you want to use the prebuilt images:
+```sh
+GIT_LFS_SKIP_SMUDGE=1 git clone https://iceshrimp.dev/iceshrimp/iceshrimp.git --depth=1
+```
+
+If you want to build your own images (make sure to install `git-lfs` before running the command):
+```sh
+git clone https://iceshrimp.dev/iceshrimp/iceshrimp.git --depth=1
+```
 
 ### docker-compose.yml
 
diff --git a/docs/install.md b/docs/install.md
index 6694f0f34..77bb9b04f 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -32,6 +32,8 @@ This document will guide you through manual installation of Iceshrimp. We also p
 
 ### Download repository
 
+Make sure you have `git-lfs` installed before cloning the repo, as we are using Git LFS for efficient storage of binary blobs.
+
 ```sh
 git clone https://iceshrimp.dev/iceshrimp/iceshrimp.git --depth=1
 ```
@@ -60,6 +62,8 @@ corepack prepare --activate
 yarn
 ```
 
+Note: If you get a lot of `The remote archive doesn't match the expected checksum` errors, please make sure you installed `git-lfs` and ran `git lfs install && git lfs fetch`.
+
 ## Building Iceshrimp
 
 ```sh
@@ -128,6 +132,8 @@ If this is your first run, after Iceshrimp has started successfully, you'll be a
 
 ### Updating Iceshrimp
 
+Before you start, if you cloned the iceshrimp repository before the Git LFS migration, please follow [these instructions](https://iceshrimp.dev/iceshrimp/iceshrimp/wiki/Git-LFS#fixing-up-a-preexisting-cloned-repo) to get your repository back in sync.
+
 First, stop the Iceshrimp service and then run the following commands:
 
 ```sh
@@ -154,6 +160,8 @@ yarn
 yarn build && yarn migrate
 ```
 
+Note: If you get a lot of `The remote archive doesn't match the expected checksum` errors, please make sure you installed `git-lfs` and ran `git lfs install && git lfs fetch`.
+
 Now restart the Iceshrimp service and everything should be up to date.
 
 ## Post-install