diff --git a/CHANGELOG.md b/CHANGELOG.md index 817b37c7..a1adb33e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,50 +1,34 @@ -1.4.0 +1.5.0 > MAJOR PATCH ## Major Implementations -### Antiraid System [#159] +### Landing Page -A new guild security feature has been added to shinpuru: The Antiraid System. +shinpurus `/login` page is now decorated by a landing page which shows off some of shinpurus core features, some invite links and options to self host as well as some links to dive deeper. -> **What is a "Raid"?** -> A guild raid is mostly refered to a large, burst-like ammount of accounts joining the guild in a short period of time. This is mostly caused by a single user or a group of users which utilize bot-created or hijacked accounts to flood a guild. +> This page is still in a kind of **beta state**. A lot of stuff is still missing like proper support for mobile devices as well as further feature spotlights. -To counteract this, the antiraid system constantly checks the rate of users joining your guild. If the rate increases over a certain threshold, the antiraid system triggers. Following, the guilds security level is raised to `verry high` and for the following 24 hours, all users joining the guild are logged in a list which is accessable via the web interface. Also, all admins of the guild will be informed about the incident. +![](https://i.imgur.com/4V6VVab.gif) -Of course, the antiraid system can be toggled and the trigger threshold values can be managed in the web interface *(if you have the `sp.guild.config.antiraid` permission)*. -![](https://i.imgur.com/vLMgrM9.png) - -### Metrics Monitoring [#170] - -You are now able to monitor core metrics of shinpuru using Prometheus and Grafana. - -You can enable the prometheus scraping endpoint by adding this to your shinpuru config: -```yml -metrics: - enable: true - addr: ":9091" -``` - -[Here](https://github.com/zekroTJA/shinpuru/blob/master/config/prometheus/prometheus.yml) you can find an example Prometheus configuration and [here](https://github.com/zekroTJA/shinpuru/blob/master/config/grafana/example-dashboard.json) you can find an example grafana dashboard to monitor shinpuru's metrics. - -*Example dashboard. Data from shinpuru Canary instance.* -![](https://i.imgur.com/fEkV7fe.png) +## Minor Updates +- Two imporvements of the color feature: + 1. A name of the color which is closest to the specified color is now displayed. This is provided by the [`zekroTJA/colorname`](https://github.com/zekroTJA/colorname) package. + 2. The name of the embed executor is now displayed in the embed footer. [#183] -## Minor Updates + ![](https://i.imgur.com/4dzBN8z.png) -- Add aliases to `karma` command: `leaderboard`, `lb`, `sb` and `top`. [#181] -- The `karma` command now shows the karma points of a user when specified as argument. [#179] +- The web server endpoint `/invite` now redirects to the invite link of the current shinpuru instance (e.g. https://shnp.de/invite). ## Bug Fixes -- The web frontend route `/guilds/:guildid/guildadmin` now redirects to `/guilds/:guildid/guildadmin/antiraid` instead of firing errors. [#180] +- Fix hex notation of color reaction embeds. ## Backstage -- Updated a bit of the project structure: The packages `listeners` and `webserver` are now moved into the `internal/core` package. +- Move `stringutils` package to `pkg/stringutils`. # Docker diff --git a/bughunters.md b/bughunters.md index bcde67e5..13a1cedb 100644 --- a/bughunters.md +++ b/bughunters.md @@ -4,7 +4,7 @@ A list to honor all people who found some bugs, had some great ideas or contribu | GitHub | Issues | PRs | Points* | |--------|--------|-----|---------| -| [voxain](https://github.com/voxain) | [#52](https://github.com/zekroTJA/shinpuru/issues/52), [#61](https://github.com/zekroTJA/shinpuru/issues/61), [#67](https://github.com/zekroTJA/shinpuru/issues/67), [#147](https://github.com/zekroTJA/shinpuru/issues/147), [#148](https://github.com/zekroTJA/shinpuru/issues/148), [#150](https://github.com/zekroTJA/shinpuru/issues/150), [#153](https://github.com/zekroTJA/shinpuru/issues/153), [#159](https://github.com/zekroTJA/shinpuru/issues/159), [#163](https://github.com/zekroTJA/shinpuru/issues/163), [#165](https://github.com/zekroTJA/shinpuru/issues/165) | | `10` | +| [voxain](https://github.com/voxain) | [#52](https://github.com/zekroTJA/shinpuru/issues/52), [#61](https://github.com/zekroTJA/shinpuru/issues/61), [#67](https://github.com/zekroTJA/shinpuru/issues/67), [#147](https://github.com/zekroTJA/shinpuru/issues/147), [#148](https://github.com/zekroTJA/shinpuru/issues/148), [#150](https://github.com/zekroTJA/shinpuru/issues/150), [#153](https://github.com/zekroTJA/shinpuru/issues/153), [#159](https://github.com/zekroTJA/shinpuru/issues/159), [#163](https://github.com/zekroTJA/shinpuru/issues/163), [#165](https://github.com/zekroTJA/shinpuru/issues/165), [#183](https://github.com/zekroTJA/shinpuru/issues/183), [#187](https://github.com/zekroTJA/shinpuru/issues/187) | | `12` | | [SnowLeoo](https://github.com/SnowLeoo) | [#129](https://github.com/zekroTJA/shinpuru/issues/129), [#145](https://github.com/zekroTJA/shinpuru/issues/145), [#169](https://github.com/zekroTJA/shinpuru/issues/169) | [#175](https://github.com/zekroTJA/shinpuru/pull/175), [#176](https://github.com/zekroTJA/shinpuru/pull/176), [#178](https://github.com/zekroTJA/shinpuru/pull/178) | `9` | | [error2507](https://github.com/error2507) | [#28](https://github.com/zekroTJA/shinpuru/issues/28), [#29](https://github.com/zekroTJA/shinpuru/issues/29), [#55](https://github.com/zekroTJA/shinpuru/issues/55) | [#1](https://github.com/zekroTJA/shinpuru/pull/1), [#2](https://github.com/zekroTJA/shinpuru/pull/2) | `7` | | [Ron31](https://github.com/Ron31) | | [#32](https://github.com/zekroTJA/shinpuru/pull/32), [#181](https://github.com/zekroTJA/shinpuru/pull/181) | `4` | @@ -21,6 +21,7 @@ A list to honor all people who found some bugs, had some great ideas or contribu | [Zoriot](https://github.com/Zoriot) | [#128](https://github.com/zekroTJA/shinpuru/issues/128) | | `1` | | [okrplay](https://github.com/okrplay) | [#162](https://github.com/zekroTJA/shinpuru/issues/162) | | `1` | | [cloudybyte](https://github.com/cloudybyte) | [#179](https://github.com/zekroTJA/shinpuru/issues/179) | | `1` | +| [ENOT1KK](https://github.com/ENOT1KK) | [#184](https://github.com/zekroTJA/shinpuru/issues/184) | | `1` | ---