suggestions, fixes

This commit is contained in:
Jeder 2023-08-10 20:58:16 +02:00 committed by Laura Hausmann
parent 897ddb5535
commit 483fc5f053
No known key found for this signature in database
GPG key ID: D044E84C5BE01605
2 changed files with 12 additions and 12 deletions

View file

@ -11,8 +11,8 @@ This document will guide you through manual installation of Iceshrimp on dev bra
### Required
- [**Node.js**](https://nodejs.org) v18.16.0+ (v20 recommended)
- [**PostgreSQL**](https://www.postgresql.org/) 12+ (14 recommended)
- [**Redis**](https://redis.io/) 6+ (7 recommended)
- [**PostgreSQL**](https://www.postgresql.org/) 12+
- [**Redis**](https://redis.io/) 6+
- [**libvips**](https://www.libvips.org/)
- **Web proxy**
- nginx
@ -45,7 +45,7 @@ Following steps will require you to run them as the user you have made, so use `
- Copy `.config/example.yml` to `.config/default.yml`
- Edit `.config/default.yml` with text editor
- Make sure to set PostgreSQL and Redis section correctly
- Make sure to set/uncomment caching server and/or text search sections if you happen to set up these too
- Make sure to set/uncomment caching server and/or text search sections if you have chosen to set up these
## Installing project dependencies
```sh
@ -97,7 +97,7 @@ example.com {
## Running Iceshrimp
### Running manually
- Start Iceshrimp by running `yarn run start`.
- Start Iceshrimp by running `NODE_ENV=production yarn run start`.
If this is your first run, after Iceshrimp has started successfully, you'll be able to go to the URL you have specified in `.config/default.yml` and create first user.
- To stop the server, use `Ctrl-C`.
@ -112,12 +112,12 @@ If this is your first run, after Iceshrimp has started successfully, you'll be a
Shut down Iceshrimp and then run these commands
```sh
## Do git stash commands only if you had made changes to the repo
## Run git stash commands only if you have uncommitted changes
git stash
git pull
git stash pop
yarn
NODE_ENV=production yarn build && yarn migrate
yarn build && yarn migrate
```
Start Iceshrimp back up

View file

@ -22,9 +22,9 @@ Recommended if using Docker
- Go to Control Panel > Object Storage and follow instructions
## Customising assets, locale
- To add custom CSS for all users, edit ./custom/assets/instance.css.
- To add static assets (such as images for the splash screen), place them in the ./custom/assets/ directory. They'll then be available on https://example.com/static-assets/filename.ext.
- To add custom locales, place them in the ./custom/locales/ directory. If you name your custom locale the same as an existing locale, it will overwrite it. If you give it a unique name, it will be added to the list. Also make sure that the first part of the filename matches the locale you're basing it on. (Example: en-FOO.yml)
- To add custom error images, place them in the ./custom/assets/badges directory, replacing the files already there.
- To add custom sounds, place only mp3 files in the ./custom/assets/sounds directory.
- To update custom assets without rebuilding, just run pnpm run gulp.
- To add custom CSS for all users, edit `custom/assets/instance.css`.
- To add static assets (such as images for the splash screen), place them in the `custom/assets/` directory. They'll then be available on https://example.com/static-assets/filename.ext.
- To add custom locales, place them in the `custom/locales/` directory. If you name your custom locale the same as an existing locale, it will overwrite it. If you give it a unique name, it will be added to the list. Also make sure that the first part of the filename matches the locale you're basing it on. (Example: en-FOO.yml)
- To add custom error images, place them in the `custom/assets/badges` directory, replacing the files already there.
- To add custom sounds, place only mp3 files in the `custom/assets/sounds` directory.
- To update custom assets without rebuilding, just run `yarn run gulp`.