Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thomaspockrandt authored Dec 20, 2021
1 parent 89ffd5f commit c4d755f
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,28 @@
# Strapi plugin strapi-plugin-basic-auth
# Strapi Plugin Basic Authentication
Basic Authentication Middleware for Strapi CMS

A quick description of strapi-plugin-basic-auth.
## Integration
Enable the plugin by adding it to the plugins configurations file:
```
// path: /path/to/myDevelopmentProject/config/plugins.js
module.exports = {
// ...
'strapi-plugin-basic-auth': {
enabled: true,
resolve: './src/plugins/strapi-plugin-basic-auth'
},
// ...
}
```

## Admin User Interface
Use your regular Strapi CMS user to login with basic authentication.

## Programmatic access (Serverless Function, ..)
```
curl "https://localhost:1337/graphql" \
-H 'x-api-key: X_API_KEY'
```

`X_API_KEY` is set as environment variable on the Strapi CMS host.

0 comments on commit c4d755f

Please sign in to comment.