Skip to content

Commit 4dff7eb

Browse files
authored
docs: move system requirements above install instructions
1 parent 80320f7 commit 4dff7eb

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

readme.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,14 @@ This reporter is designed to support mass and cross-server notification use case
163163

164164
The webhook reporter is disabled by default.
165165

166+
## System Requirements
167+
168+
* [.NET 8 (or later) Runtime](https://dotnet.microsoft.com/en-us/download)
169+
* [A supported version of Windows, Linux, or macOS](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) (Linux is recommended)
170+
* At least 128 MB available RAM (256 MB recommended)
171+
* A functional installation of [Sharkey](https://activitypub.software/TransFem-org/Sharkey)
172+
* Network or localhost connection to Sharkey's backend API
173+
* Network or localhost connection to Sharkey's PostgreSQL database, and a user with read/write permissions
166174

167175
## Installing ModShark
168176

@@ -203,15 +211,6 @@ Make sure to substitute all variables for their correct values.
203211
4. Revert ModShark's database changes: `psql -U $postgres_user -W -d $sharkey_database -a -f uninstall-ModShark-migrations.sql`
204212
5. Remove ModShark files: `rm -r $modshark_directory`
205213

206-
### System Requirements
207-
208-
* [.NET 8 (or later) Runtime](https://dotnet.microsoft.com/en-us/download)
209-
* [A supported version of Windows, Linux, or macOS](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) (Linux is recommended)
210-
* At least 128 MB available RAM (256 MB recommended)
211-
* A functional installation of [Sharkey](https://activitypub.software/TransFem-org/Sharkey)
212-
* Network or localhost connection to Sharkey's backend API
213-
* Network or localhost connection to Sharkey's PostgreSQL database, and a user with read/write permissions
214-
215214
## Configuration
216215

217216
ModShark uses a layered configuration approach that allows for automatic updates without clobbering changes.
@@ -228,10 +227,8 @@ Some common values are `appsettings.Development.json`, `appsettings.Testing.json
228227
There is also a special `appsettings.Local.json`, which will be loaded as an **additional** layer on top of `appsettings.Development.json`.
229228
This file exists to store local secrets that should not be committed to source control.
230229

231-
232230
### Configuration Properties
233231

234-
235232
| Property | Type | Description |
236233
|------------------------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
237234
| `Logging.LogLevel` | Hash | Sets the minimum log severity.<br/>See this [Microsoft article](https://learn.microsoft.com/en-us/dotnet/core/extensions/logging?tabs=command-line#configure-logging-without-code) for details.<br/><pre><code>{<br/> "Default": "Warning",<br/> "ModShark": "Information",<br/> "Microsoft.Hosting.Lifetime": "Information"<br/>}</code></pre> |

0 commit comments

Comments
 (0)