admin-fe/README.md

93 lines
3.6 KiB
Markdown
Raw Permalink Normal View History

2019-08-14 21:49:37 +00:00
# Pleroma AdminFE
2017-11-21 08:10:22 +00:00
2019-08-14 21:49:37 +00:00
![screenshot](./public/index.png)
2017-07-31 06:45:32 +00:00
2019-08-14 21:49:37 +00:00
## About
2017-07-31 06:45:32 +00:00
2019-09-27 12:54:03 +00:00
Admin UI for pleroma instance owners.
2019-11-29 07:17:07 +00:00
### 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
2019-09-27 12:54:03 +00:00
### Features
1. 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
1. Invites management: generate invite tokens & send invites via email
1. Moderation log: track moderator/admin actions
1. Settings: configure your pleroma instance via friendly (hopefully) UI
1. 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
2019-12-15 15:42:43 +00:00
### 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
```
# install dependencies
npm install -g yarn
yarn
# run AdminFE locally
yarn dev
```
### Build
To compile everything for production run
```
# install dependencies
npm install -g yarn
yarn
# compile everything for production
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
2019-09-27 12:41:54 +00:00
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.
2017-05-31 10:28:06 +00:00
## Changelog
2018-08-15 07:48:30 +00:00
2019-08-14 21:49:37 +00:00
Detailed changes for each release are documented in the [CHANGELOG](./CHANGELOG.md).
2018-03-01 02:41:09 +00:00
2018-10-15 09:21:17 +00:00
## Browsers support
Modern browsers and Internet Explorer 10+.
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
| --------- | --------- | --------- | --------- |
| IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions
2017-07-19 08:23:40 +00:00
## License
2019-08-14 21:49:37 +00:00
Pleroma AdminFE is build on top of the [Vue Element Admin](https://github.com/PanJiaChen/vue-element-admin), which is licensed under [MIT](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE) license.
2019-08-14 21:49:37 +00:00
AdminFE's own code is licensed under [AGPL](./AGPL-3)