Download the PHP package sbuerk/typo3-ensure-admin without Composer

On this page you can find all versions of the php package sbuerk/typo3-ensure-admin. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package typo3-ensure-admin

TYPO3 Ensure Admin

State

Workflow main (2.x) 1 (1.x)
tests core 10 - tests core 10
tests core 11 tests core 11 -
tests core 12 tests core 12 -

Mission

The mission of this extension is to provide a tool to create and update users for staging and development purpose. Thus, it should be only taken as development dependencies for projects.

Additionally, it provides a simple password encoding command, which may be used to encode a password and use it to set the TYPO3 installtool password, for example.

:information_source: This extension only handles backend user compatible passwords. This means, Frontend Users passwords are not handled.

Version compatibility

version TYPO3 PHP
2.x v11 + v12 7.4, 8.0, 8.1, 8.2
1.x v10 7.2, 7.3, 7.4

Alternatives

TYPO3 Console includes some commands, which (partly) can do which this extension tries to archieve. If you are already using it, maybe existing features suits you. Then stay with that extension.

:information_source: We are not aware of further extensions providing similar abilities. Let us know if there are some, and we will add them here as alternative.

Installation

Composer

You probably want to install this as --dev dependency.

Usage

ensure admin user

Synopsis:

This command can be used to create or update admin user. If a user exists, the --force flag must be provided to update the admin user.

Additionally, this command supports JSON Response results instead of normal text outputs, which may be used for integrating in other tools or workflows. Use the --json flag to retrieve JSON Results.

Some options are required and mandatory, others are optional. Options can be provided as command line options or as Environment Variables, except --json and --enforce flags.

:information_source: If for an option both variants are provided, the option variants preceeds the Environment Variable variant.

option required env variable description
--name= yes TYPO3_ENSUREADMIN_USERNAME Admin username
--password= yes TYPO3_ENSUREADMIN_PASSWORD Sets the admin password
--email= no TYPO3_ENSUREADMIN_EMAIL Sets the admin email address.
--firstname= no TYPO3_ENSUREADMIN_FIRSTNAME Will be used in combination with lastname to set the admin realName
--lastname= no TYPO3_ENSUREADMIN_LASTNAME Will be used in combination with firstname to set the admin realName
--json no - Return messages as json objects/strings
--force no* - Required if you want to update an existing admin user. Optional/not used if new admin user is created.

JSON Response structure:

Normal mode and JSON result mode both provides proper exit codes, which may be used as a first indicator without really reading the output.

result-state exit code
success 0
failure 1

password encode

Synopsis:

argument/option description
plain-password You must specify the plan password you want to encode. This is required.
--json Optional Add this flag if you want json responses instead of human readable output.

JSON Response structure:

Normal mode and JSON result mode both provides proper exit codes, which may be used as a first indicator without really reading the output.

result-state exit code
success 0
failure 1

TYPO3 Extension Repository

For non-composer projects, the extension is available in TER as extension key cli_ensure_admin and can be installed using the extension manager.

Tagging and releasing

packagist.org is enabled via the casual github hook. TER releases are created by the "publish.yml" github workflow when tagging versions using tailor. The commit message of the tagged commit is used as TER upload comment.

Feedback / Bug reports / Contribution

Bug reports, feature requests and pull requests are welcome in the GitHub repository: https://github.com/sbuerk/typo3-ensure-admin

All versions of typo3-ensure-admin with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0 || ^8.1
typo3/cms-core Version ^11.5 || ^12.0 || 12.0.*@dev
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package sbuerk/typo3-ensure-admin contains the following files

Loading the files please wait ....