No description

Find a file

Angelina Filippova 01b2d6718e Make Submit button sticky		2020-01-22 18:58:12 +07:00
build	Add configuration for sharing emoji packs	2019-09-23 18:42:18 +00:00
config	Add ability to disable settings/reports during compile time	2019-09-14 22:17:24 +00:00
public	Add README	2019-08-14 21:49:37 +00:00
src	Make Submit button sticky	2020-01-22 18:58:12 +07:00
static	Keep static dir	2019-11-01 19:22:22 +03:00
test	Ability to remove settings from db	2020-01-21 18:16:56 +00:00
.babelrc	Add tests	2019-03-22 20:58:58 +00:00
.editorconfig	add editorconfig	2017-07-24 17:58:46 +08:00
.eslintignore	init	2017-04-18 15:09:13 +08:00
.eslintrc.js	Add forms for configuring server-settings	2019-08-09 16:45:25 +00:00
.gitignore	Add test coverage to gitignore	2019-05-30 14:30:55 +02:00
.gitlab-ci.yml	Reporting enhancements	2019-07-24 20:50:45 +00:00
.postcssrc.js	Fix display of the icons	2019-06-21 11:24:39 +00:00
.travis.yml	perf[chore]:set travis notifications:false	2017-12-11 14:20:23 +08:00
AGPL-3	Add README	2019-08-14 21:49:37 +00:00
CHANGELOG.md	Revert "Merge branch 'feature/stats' into 'develop'"	2019-12-21 20:32:38 +00:00
favicon.ico	perf:change favicon	2017-11-23 10:35:54 +08:00
index.html	Kill tinymce	2019-11-01 18:55:59 +03:00
LICENSE	fixed typo	2017-12-29 16:11:20 +08:00
package.json	Ability to remove settings from db	2020-01-21 18:16:56 +00:00
README.md	Revert "Merge branch 'feature/stats' into 'develop'"	2019-12-21 20:32:38 +00:00
README.png	Add README	2019-08-14 21:49:37 +00:00
yarn.lock	Ability to remove settings from db	2020-01-21 18:16:56 +00:00

README.md

Pleroma AdminFE

About

Admin UI for pleroma instance owners.

Branches

There are two main branches here:

develop: ongoing work and all merge requests go here, unstable
master: after develop is stabilized it is merged to master, master is stable, allegedly

Features

User administration: grant roles to users (admin/moderator), deactivate/delete as well as force their statuses to have NSFW tag, strip media and many more
Invites management: generate invite tokens & send invites via email
Moderation log: track moderator/admin actions
Settings: configure your pleroma instance via friendly (hopefully) UI
Emoji packs: configure your emoji packs

You can have any combination of these features (i.e. you can disable anything, but user administration, see "Disabling features" section below).

Usage

Bundled

AdminFE is bundled with Pleroma, i.e. you can just visit https://your.instance/pleroma/admin/ to try it out.

Development

To run AdminFE locally execute yarn dev

Build

To compile everything for production run yarn build:prod, this will build admin-fe into dist folder, which you will need to upload to your server and/or point your webserver of choice to.

Disabling features

You can disable certain AdminFE features, like reports or settings by modifying config/prod.env.js env variable DISABLED_FEATURES, e.g. if you want to compile AdminFE without "Settings" you'll need to set it to: DISABLED_FEATURES: '["settings"]'.

Features, that can be disabled:

reports: DISABLED_FEATURES: '["reports"]'
invites: DISABLED_FEATURES: '["invites"]'
moderation log: DISABLED_FEATURES: '["moderationLog"]'
settings: DISABLED_FEATURES: '["settings"]'
emoji packs: DISABLED_FEATURES: '["emojiPacks"]'

Of course, you can disable multiple features just by adding to the array, e.g. DISABLED_FEATURES: '["emojiPacks", "settings"]' will have both emoji packs and settings disabled.

Users administration cannot be disabled.

Changelog

Detailed changes for each release are documented in the CHANGELOG.

Browsers support

Modern browsers and Internet Explorer 10+.

IE / Edge	Firefox	Chrome	Safari
IE10, IE11, Edge	last 2 versions	last 2 versions	last 2 versions

License

Pleroma AdminFE is build on top of the Vue Element Admin, which is licensed under MIT license.

AdminFE's own code is licensed under AGPL