ash/iceshrimp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

[docs] Add git-lfs disclaimers

Browse source
This commit is contained in:
Laura Hausmann 2023-11-08 15:59:52 +01:00
parent 76db23855c
commit 4abab16b25
No known key found for this signature in database
GPG key ID: D044E84C5BE01605
2 changed files with 17 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/docker-compose-install.md
View file

@ -6,7 +6,15 @@ This guide is based on `docker compose`/Docker Compose v2, but `docker-compose`/
### Getting needed files ### 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 ### docker-compose.yml

8
docs/install.md
View file

@ -32,6 +32,8 @@ This document will guide you through manual installation of Iceshrimp. We also p
### Download repository ### 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 ```sh
git clone https://iceshrimp.dev/iceshrimp/iceshrimp.git --depth=1 git clone https://iceshrimp.dev/iceshrimp/iceshrimp.git --depth=1
``` ```
@ -60,6 +62,8 @@ corepack prepare --activate
yarn 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 ## Building Iceshrimp
```sh ```sh
@ -128,6 +132,8 @@ If this is your first run, after Iceshrimp has started successfully, you'll be a
### Updating Iceshrimp ### 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: First, stop the Iceshrimp service and then run the following commands:
```sh ```sh
@ -154,6 +160,8 @@ yarn
yarn build && yarn migrate 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. Now restart the Iceshrimp service and everything should be up to date.
## Post-install ## Post-install