Code Monkey home page Code Monkey logo

admin-fe's Introduction

Pleroma AdminFE

screenshot

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

  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
  2. Invites management: generate invite tokens & send invites via email
  3. Moderation log: track moderator/admin actions
  4. Settings: configure your pleroma instance via friendly (hopefully) UI
  5. 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

# install dependencies
npm install -g yarn
yarn

# run AdminFE locally
NODE_OPTIONS=--openssl-legacy-provider yarn dev

Build

To compile everything for production run

# install dependencies
npm install -g yarn
yarn

# compile everything for production
NODE_OPTIONS=--openssl-legacy-provider 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
IE / Edge
Firefox
Firefox
Chrome
Chrome
Safari
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

admin-fe's People

Contributors

linakirsanova avatar panjiachen avatar maksimf avatar feld avatar darkkirb avatar floatingghost avatar github-actions[bot] avatar dependabot[bot] avatar marykatefain avatar spiritree avatar leij1ang avatar vaartis avatar wyudong avatar yugasun avatar dongsuo avatar kphrx avatar mimimile avatar xqbumu avatar zyszys avatar ruochuan12 avatar sunchenguang avatar tmpbook avatar happystory avatar theoneric avatar painnick avatar lanodan avatar dingyi1993 avatar donng avatar erisdisqordia avatar frank10000 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.