e2net/iceshrimp
3
0
Fork 0
forked from mirrors/iceshrimp
Code Pull requests Activity

[docs] Update bare metal install guide

Browse source
This commit is contained in:
Laura Hausmann 2023-11-07 01:53:25 +01:00
parent ecb54be00b
commit 1488529228
Signed by: zotan
GPG key ID: D044E84C5BE01605
1 changed files with 20 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs/install.md
View file

@ -1,6 +1,6 @@
# Installing Iceshrimp # Installing Iceshrimp
This document will guide you through manual installation of Iceshrimp on dev branch, for main branch, use Firefish's installation guide. This document will guide you through manual installation of Iceshrimp. We also provide prebuilt [packages](/iceshrimp/packaging) for various platforms, should you prefer those over a manual install.
## Dependencies ## Dependencies
@ -36,6 +36,8 @@ This document will guide you through manual installation of Iceshrimp on dev bra
git clone https://iceshrimp.dev/iceshrimp/iceshrimp.git --depth=1 git clone https://iceshrimp.dev/iceshrimp/iceshrimp.git --depth=1
``` ```
If you don't want to run the latest development version, pick a version from [here](https://iceshrimp.dev/iceshrimp/iceshrimp/releases) and run `git checkout <version>` before continuing.
### Creating a new user ### Creating a new user
In case you want to run Iceshrimp as a different user, run `adduser --disabled-password --disabled-login iceshrimp` In case you want to run Iceshrimp as a different user, run `adduser --disabled-password --disabled-login iceshrimp`
@ -126,18 +128,33 @@ If this is your first run, after Iceshrimp has started successfully, you'll be a
### Updating Iceshrimp ### Updating Iceshrimp
Shut down Iceshrimp and then run these commands First, stop the Iceshrimp service and then run the following commands:
```sh ```sh
## Run git stash commands only if you have uncommitted changes ## Run git stash commands only if you have uncommitted changes
git stash git stash
```
If you were previously running a tagged release and/or want to upgrade to one, run:
```sh
git fetch --tags
git checkout <new-version>
```
If you were previously running a development version, and want to continue doing so or switch to the latest commit, run:
```sh
git switch dev
git pull git pull
```
Regardless of which of the above you picked, run:
```sh
git stash pop git stash pop
yarn yarn
yarn build && yarn migrate yarn build && yarn migrate
``` ```
Start Iceshrimp back up Now restart the Iceshrimp service and everything should be up to date.
## Post-install ## Post-install