Compare revisions

# SPDX-FileCopyrightText: 2019-2022 Pleroma Authors <https://pleroma.social>

# SPDX-License-Identifier: AGPL-3.0-only

# block everything

**

# allowed files

!AGPL-3

!CHANGELOG.md

!README.md

!.babelrc

!.eslintignore

!.eslintrc.js

!.postcssrc.js

!favicon.ico

!index.html

!package.json

!yarn.lock

# allowed subdirectories

!/build/**

!/config/**

!/docker/**

!/public/**

!/static/**

!/src/**

# blocked subdirectory files

**/*.log

**/*~

**/.DS_Store

**/Thumbs.db

# SPDX-FileCopyrightText: 2017-2019 PanJiaChen <https://github.com/PanJiaChen/vue-element-admin>

# SPDX-License-Identifier: MIT

# http://editorconfig.org

root = true

# SPDX-FileCopyrightText: 2017-2019 PanJiaChen <https://github.com/PanJiaChen/vue-element-admin>

# SPDX-License-Identifier: MIT

build/*.js

config/*.js

src/assets

// SPDX-FileCopyrightText: 2017-2019 PanJiaChen <https://github.com/PanJiaChen/vue-element-admin>

// SPDX-License-Identifier: MIT

//

// SPDX-FileCopyrightText: 2019-2022 Pleroma Authors <https://pleroma.social>

// SPDX-License-Identifier: AGPL-3.0-only

module.exports = {

  root: true,

  parserOptions: {

# SPDX-FileCopyrightText: 2017-2019 PanJiaChen <https://github.com/PanJiaChen/vue-element-admin>

# SPDX-License-Identifier: MIT

#

# SPDX-FileCopyrightText: 2019-2022 Pleroma Authors <https://pleroma.social>

# SPDX-License-Identifier: AGPL-3.0-only

.DS_Store

node_modules/

dist/

image: node:10

# SPDX-FileCopyrightText: 2019-2022 Pleroma Authors <https://pleroma.social>

# SPDX-License-Identifier: AGPL-3.0-only

image: node:20-alpine

variables: &global_variables

  DOCKER_DRIVER: overlay2

  DOCKER_HOST: unix:///var/run/docker.sock

cache: &global_cache_policy

  key: '$CI_COMMIT_SHORT_SHA'

  policy: pull-push

  paths:

    - node_modules/

    - build

stages:

  - lint

  - build

  - test

lint:

  stage: lint

build:

  stage: build

  before_script: &before-build

    - apk --no-cache add git python3 build-base

  script:

    - yarn

    - yarn lint

    - yarn build:prod

  artifacts: &release-artifacts

    name: "admin-fe-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA"

    paths:

      - dist/

test:

lint:

  stage: test

  variables:

    APT_CACHE_DIR: apt-cache

  script:

  before_script: &before-yarn

    - apk --no-cache add git python3 build-base

    - yarn

    - yarn test

  cache:

    key: '$CI_COMMIT_SHORT_SHA'

    policy: pull

  script:

    - yarn lint

build:

  stage: build

test:

  stage: test

  before_script: *before-yarn

  cache:

    key: '$CI_COMMIT_SHORT_SHA'

    policy: pull

  script:

    - yarn

    - npm run build:prod

    - yarn test --coverage

  coverage: '/^Lines *: *([^ ]*%) [^%]*$/'

  artifacts:

    reports:

      coverage_report:

        coverage_format: cobertura

        path: coverage/cobertura-coverage.xml

// SPDX-FileCopyrightText: 2017-2019 PanJiaChen <https://github.com/PanJiaChen/vue-element-admin>

// SPDX-License-Identifier: MIT

//

// SPDX-FileCopyrightText: 2019-2022 Pleroma Authors <https://pleroma.social>

// SPDX-License-Identifier: AGPL-3.0-only

// https://github.com/michael-ciniawsky/postcss-load-config

module.exports = {

Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/

Source: https://git.pleroma.social/pleroma/admin-fe/

# Grabbed from tiptap@1.29.6

# See https://github.com/ueberdosis/tiptap/blob/tiptap%401.29.6/LICENSE.md

# and https://github.com/ueberdosis/tiptap/tree/tiptap%401.29.6/examples/assets/images/icons

Files: src/icons/svg/tiptap-*.svg

Copyright: 2020 überdosis GbR

License: MIT

yarn 1.22.19

nodejs 20.14.0

# SPDX-FileCopyrightText: 2017-2019 PanJiaChen <https://github.com/PanJiaChen/vue-element-admin>

# SPDX-License-Identifier: MIT

language: node_js

node_js: stable

script: npm run test

<!--

SPDX-FileCopyrightText: 2019-2022 Pleroma Authors <https://pleroma.social>

SPDX-License-Identifier: AGPL-3.0-only

-->

# Changelog

All notable changes to this project will be documented in this file.

## Unreleased

### Added

### Changed

- moves emoji pack configuration from the main menu to settings tab, redesigns it and fixes bugs

- `mailerEnabled` must be set to `true` in order to require password reset (password reset currently only works via email)

- remove fetching initial data for configuring server settings

- Actions in users module (ActivateUsers, AddRight, DeactivateUsers, DeleteRight, DeleteUsers) now accept an array of users instead of one user

- Leave dropdown menu open after clicking an action

### Fixed

- The Service account type has been renamed to Bot so it's consistent with the termoniology used by most fediverse software.

## [2.5.0] - 2022-12-21

### Added

- Support for fine-grained privileges

### Added

- Support for fine-grained privileges

### Fixed

- Crash when parsing tuples in Settings

- Broken parsing of Settings

## [2.4.0] - 2021-08-01

### Added

- Evicting and banning objects from the MediaProxy cache is disabled if MediaProxy is disabled on the Settings tab. Add ability to enable MediaProxy and Invalidation from MediaProxy tab.

- Allow to upload the custom Terms of Service and Instance Panel HTML pages via Admin API

- Add Report show page and link Moderation log references to the respective reports

- Add Unconfimed filter for Users table

- Filter users by actor type: Person, Bot or Application

- Add ability to configure Media Preview Proxy, User Backup, Websocket based federation and Pleroma.Web.Endpoint.MetricsExporter settings

- Mobile and Tablet UI for Single Report show page

- Ability to set rules and conditions for rendering settings (e.g. `:proxy_remote` setting is hidden if `:uploader` setting is set to `Pleroma.Uploaders.Local`)

- Ability to install new frontends from the Frontend tab in the Settings section

### Changed

- **Breaking**: AdminAPI changed User field `confirmation_pending` to `is_confirmed`

- **Breaking**: AdminAPI changed User field `approval_pending` to `is_approved`

- **Breaking**: AdminAPI changed User field `deactivated` to `is_active`

- Hide Tag actions on Users tab if MRF TagPolicy is disabled. Add ability to enable TagPolicy from Moderation menu

- Move `:restrict_unauthenticated` settings from Authentication tab to Instance tab

- Replace regular inputs with textareas for setting welcome messages in the Settings section

- Remove Websocket based federation settings

- Move Settings tab navigation from the tabbed menu to the main sidebar menu. A separate route is created for each tab.

- Move Emoji packs configuration to the Emoji tab in the Settings section

- 401 and 404 error pages updated

- Remove unused components

### Fixed

- Fix depricatied action names in Reports, move actions that manage users from Reports to reports module

- Allow using underscores and hyphens in new account's usernames

- Fix wrapping `:icons` setting and parsing tuples in settings with key `:headers`

- Update keys for Pleroma.Web.Plugs.RemoteIp and PurgeExpiredActivity settings

- Update switching between local and remote emoji packs panels: the panel with the pack's metadata will be closed when another panel is opened

- Fix displaying messages for multiple errors

## [2.2] - 2020-11-18

### Added

- Ability to configure Media Preview Proxy settings on MediaProxy tab

### Fixed

- Update keys for PurgeExpiredActivity and RemoteIp settings

- Fix wrapping `:icons` setting and parsing tuples in settings with key `:headers`

## [2.1] - 2020-08-26

### Added

- Create `/statuses/:id` route that shows single status

- Add link to the user's account in Pleroma on the user's profile page

- On Reports page add links to reported account and the author of the report 

- In Notes add link to the note author's profile page 

- In Moderation log add link to the actor's profile page

- Support pagination of local emoji packs and files

- Add MRF Activity Expiration setting

- Add ability to disable multi-factor authentication for a user

- Add ability to configure Invalidation settings on MediaProxy tab

- Ability to configure `S3` settings on Upload tab, `Pleroma.Web.ApiSpec.CastAndValidate` and `:modules` settings on Other tab, `:pools`, `:connections_pool` and `:hackney_pools` settings on Job Queue tab, `:restrict_unauthenticated` settings on Authentication tab, `:favicons` and `:welcome` settings on Instance tab, `:frontends` and `Pleroma.Web.Preload` settings on Frontend tab

- Show number of open reports in Sidebar Menu

- Add confirmation message when deleting a user

- Add new MediaProxy Cache Tab with ability to manually evict and ban objects from the Pleroma MediaProxy cache

- Allow managing user's actor_type field via Admin API

### Changed

- Statuses count changes when an instance is selected and shows the amount of statuses from an originating instance

- Add a confirmation dialog window when Remove button is clicked on the Settings page

- Disable tab on the Settings page if there are no settings on this tab that can be changed in Admin FE

- Settings that can't be altered in Admin FE are removed: HTTP Signatures settings, Federation publisher modules and Oban Repo

- When rendering user's profile, statuses, reports and notes check if required properties exist

- Remove ability to moderate users that don't have valid nicknames

- Displays both labels and description in the header of group of settiings

- Ability to add custom values in Pleroma.Upload.Filter.Mogrify setting in the following format: '{"implode", "1"}'

- Change types of the following settings: ':groups', ':replace', ':federated_timeline_removal', ':reject', ':match_actor'. Update functions that parses and wraps settings data according to this change.

- Move rendering Crontab setting from a separate component to EditableKeyword component

- Show only those MRF settings that have been enabled in MRF Policies setting

- Move Auto Linker settings to Link Formatter Tab as its configuration was moved to :pleroma, Pleroma.Formatter

- Active and Local filters are applied by default on the Users tab

- Update Emoji Packs API to support special chars in pack names

### Fixed

- Send `true` and `false` as booleans if they are values of single selects on the Settings page

- Fix sorting users on Users page if there is an acount with missing nickname or ID

- Add new type of settings: `['string', 'image']`. Render Image upload Input depending on the type of setting, not its key

- Fix displaying `Pending` tag and filtering by Pending Approval status

- Fix following and unfollowing relays from Admin-FE, update mobile UI

- Support special chars in Emoji packs names

## [2.0.3] - 2020-04-29

### Added

- Link settings that enable registrations and invites

- Ability to upload logo, background, default user avatar, instance thumbnail, and NSFW hiding images

### Changed

- Put Instance Reboot button on all pages of admin-fe

- Make Instance Reboot button's positon fixed on Settings page

- Update jest and babel-jest

- Generate an invite link when an invite token has been generated

- Put labels on top of inputs in mobile version

- Shorten suggestions for a series of select inputs: Rewrite policy, Pleroma Authenticator, Captcha Method, Mailer adapter, Metadata providers, Rich Media parsers, TTL setters, Scrub policy, Uploader, Filters and Federation publisher modules

### Fixed

- Disable Invites tab when invites are disabled on BE

## [2.0.2] - 2020-04-01

### Added

- Ability to see local statuses in Statuses by instance section

- Ability to configure Oban.Cron settings and settings for notifications streamer

- Settings search

- Ability to set user's password and email on user's page

- Display status count by scope on Statuses page

### Changed

- Link to Pleroma docs when a non-admin user tries to log in 

### Fixed

- Fix parsing tuples in Pleroma.Upload.Filter.Mogrify and Pleroma.Emails.Mailer settings

- Fix settings submit button position on wide screens when sidebar menu is open

- Updates links for downloading remote emoji packs

- Fix parsing emails that have symbols in it

## [2.0] - 2020-02-27

### Added

- Optimistic update for actions in users module and fetching users after api function finished its execution

- Relay management

- Ability to fetch all statuses from a given instance

- Ability to confirm users' emails and resend confirmation emails

- Report notes

- Ability to moderate users on the statuses page

- Ability to moderate user on the user's page

- Ability to remove setting's updated value and set it back to initial value

- Ability to restart an application when settings that require instance reboot were changed

- Mobile and Tablet UI for all sections

### Changed

- **breaking** PleromaFE login feature relies on `admin` scope presence in PleromaFE token (older versions of PleromaFE don't support it)

- `mailerEnabled` must be set to `true` in order to require password reset (password reset currently only works via email)

- Render inputs for configuring settings based on description that comes from the BE

- Remove fetching initial data for configuring server settings

- Actions in users module (ActivateUsers, AddRight, DeactivateUsers, DeleteRight, DeleteUsers) now accept an array of users instead of one user

- Leave dropdown menu open after clicking an action

- Display checkboxes in status card and fetch statuses only when status card was rendered from Statuses by instance page

- Move statuses by instance state from local state to store state

### Fixed

- Show checkmarks when tag is applied

- Reports update (also, now it's optimistic)

- Remove duplicated success message

- Fix styles for Statuses by instance page

- Fix styles for Reports section

- Fix listing remote emoji

## [1.2.0] - 2019-09-27

### Added

- Emoji pack configuration

- Statuses page: fetch all statuses from a given instance

- Ability to require user's password reset

– Ability to track admin/moderator actions, a.k.a. "the moderation log"

# SPDX-FileCopyrightText: 2019-2022 Pleroma Authors <https://pleroma.social>

# SPDX-License-Identifier: AGPL-3.0-only

FROM node:16-alpine as build

COPY . .

RUN apk --no-cache add git && \

    npm install && \

    npm run build:prod

FROM nginx:mainline-alpine

LABEL maintainer="ops@pleroma.social" \

    org.opencontainers.image.title="pleroma-adminfe" \

    org.opencontainers.image.description="Pleroma-adminfe for Docker" \

    org.opencontainers.image.authors="ops@pleroma.social" \

    org.opencontainers.image.vendor="pleroma.social" \

    org.opencontainers.image.documentation="https://git.pleroma.social/pleroma/pleroma-adminfe" \

    org.opencontainers.image.licenses="AGPL-3.0" \

    org.opencontainers.image.url="https://pleroma.social" \

    org.opencontainers.image.revision=$VCS_REF \

    org.opencontainers.image.created=$BUILD_DATE

ARG DATA=/usr/share/nginx/html

COPY --from=build /dist/ ${DATA}

COPY ./docker/docker-entrypoint.sh /usr/local/bin/

COPY ./docker/nginx.conf.tpl /etc/nginx/nginx.conf.tpl

RUN apk add --no-cache gettext

EXPOSE 80

ENTRYPOINT ["/usr/local/bin/docker-entrypoint.sh"]

CMD exec nginx -g 'daemon off;'

MIT License

Copyright (c) 2017-present PanJiaChen

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.

MIT License

Copyright (c) <year> <copyright holders>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Admin UI for pleroma instance owners.

### Branches

There are two main branches here:

- `develop`: ongoing work and all merge requests go here, *unstable*

- `stable`: after `develop` is stabilized it is merged to `stable`, *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

## 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`

To run AdminFE locally execute

```

# install dependencies

npm install -g yarn

yarn

# run AdminFE locally

yarn dev

```

### Build

To compile everything for production run `yarn build:prod`.

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

| --------- | --------- | --------- | --------- |

| IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions

## License

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.

AdminFE's own code is licensed under [AGPL](./AGPL-3)

## Copyright

```

Copyright 2017-2019 PanJiaChen <https://github.com/PanJiaChen/vue-element-admin>

SPDX-License-Identifier: MIT

Copyright 2019-2022 Pleroma Authors <https://pleroma.social>

SPDX-License-Identifier: AGPL-3.0-only

```

'use strict'

require('./check-versions')()

// SPDX-FileCopyrightText: 2017-2018 PanJiaChen <https://github.com/PanJiaChen/vue-element-admin>

// SPDX-License-Identifier: MIT

//

// SPDX-License-Identifier: AGPL-3.0-only

// SPDX-FileCopyrightText: 2022 Pleroma Authors <https://pleroma.social>

'use strict'

const ora = require('ora')

const rm = require('rimraf')

const path = require('path')

const chalk = require('chalk')

const webpack = require('webpack')

const config = require('../config')

const webpackConfig = require('./webpack.prod.conf')

    )

    if (stats.hasErrors()) {

      console.log(chalk.red(' Build failed with errors.\n'))

      console.log(' Build failed with errors.\n')

      process.exit(1)

    }

    console.log(chalk.cyan(' Build complete.\n'))

    console.log(' Build complete.\n')

    console.log(

      chalk.yellow(

        ' Tip: built files are meant to be served over an HTTP server.\n' +

          " Opening index.html over file:// won't work.\n"

    )

    )

    if (process.env.npm_config_preview) {

      const port = 9526

      )

      app.listen(port, function() {

        console.log(

          chalk.green(`> Listening at  http://localhost:${port}${basePath}`)

        )

        console.log(`> Listening at  http://localhost:${port}${basePath}`)

      })

    }

  })

'use strict'

const chalk = require('chalk')

const semver = require('semver')

const packageConfig = require('../package.json')

const shell = require('shelljs')

function exec(cmd) {

  return require('child_process')

    .execSync(cmd)

    .toString()

    .trim()

}

const versionRequirements = [

  {

    name: 'node',

    currentVersion: semver.clean(process.version),

    versionRequirement: packageConfig.engines.node

  }

]

if (shell.which('npm')) {

  versionRequirements.push({

    name: 'npm',

    currentVersion: exec('npm --version'),

    versionRequirement: packageConfig.engines.npm

  })

}

module.exports = function() {

  const warnings = []

  for (let i = 0; i < versionRequirements.length; i++) {

    const mod = versionRequirements[i]

    if (!semver.satisfies(mod.currentVersion, mod.versionRequirement)) {

      warnings.push(

        mod.name +

          ': ' +

          chalk.red(mod.currentVersion) +

          ' should be ' +

          chalk.green(mod.versionRequirement)

      )

    }

  }

  if (warnings.length) {

    console.log('')

    console.log(

      chalk.yellow(

        'To use this template, you must update following to modules:'

      )

    )

    console.log()

    for (let i = 0; i < warnings.length; i++) {

      const warning = warnings[i]

      console.log('  ' + warning)

    }

    console.log()

    process.exit(1)

  }

}

// SPDX-FileCopyrightText: 2017-2018 PanJiaChen <https://github.com/PanJiaChen/vue-element-admin>

// SPDX-License-Identifier: MIT

//

// SPDX-FileCopyrightText: 2022 Pleroma Authors <https://pleroma.social>

// SPDX-License-Identifier: AGPL-3.0-only

'use strict'

const path = require('path')

const config = require('../config')

  return output

}

exports.createNotifierCallback = () => {

  const notifier = require('node-notifier')

  return (severity, errors) => {

    if (severity !== 'error') return

    const error = errors[0]

    const filename = error.file && error.file.split('!').pop()

    notifier.notify({

      title: packageConfig.name,

      message: severity + ': ' + error.name,

      subtitle: filename || '',

      icon: path.join(__dirname, 'logo.png')

    })

  }

}

// SPDX-FileCopyrightText: 2017-2018 PanJiaChen <https://github.com/PanJiaChen/vue-element-admin>

// SPDX-License-Identifier: MIT

'use strict'

module.exports = {