authcompanion2
4.0.0-beta.1
Удобный для администратора сервер управления пользователями (с ключами доступа и JWT) для простой и безопасной интеграции аутентификации пользователей.
Полезные ссылки: Документация | ИЗМЕНЕНИЯ | Демо-сайт | Следуйте за Мастодонтом
AuthCompanion призван удовлетворить наиболее распространенные потребности в аутентификации и управлении пользователями вашего веб-приложения.
С помощью AuthC вы можете:
| Экран входа в систему | Экран регистрации |
|---|---|
 |  |
Инструкции ниже запустят сервер по умолчанию для изучения функций.
Предварительное требование:
Клонируйте репозиторий, если вы этого не сделали, и установите зависимости с помощью этой команды:
$ npm installКогда будете готовы, запустите сервер с настройками по умолчанию!
$ npm startЗапустите сервер (с конфигом по умолчанию):
$ docker run -it -p 3002:3002 --name AuthCompanion ghcr.io/authcompanion/authcompanion2:mainТакже доступен файл docker-compose.yml.
Если вы впервые пробуете AuthC, конфигурация по умолчанию подойдет. Подробную информацию о настройке сервера для других сред см. в Руководстве по настройке.
Когда все будет готово, прочитайте Руководство по запуску для получения дополнительной информации о настройке AuthC в рабочей среде.
Веб-формы для аутентификации пользователей. Используйте готовые и настраиваемые веб-формы, чтобы пользователи вашего приложения могли: входить в систему, используя свои учетные данные, регистрировать учетную запись, обновлять свой профиль и выдавать забытые пароли.
Панель администратора для управления профилями пользователей: изменяйте информацию профилей ваших пользователей с помощью панели самообслуживания — вся информация об учетной записи хранится в базе данных SQLite.
Восстановление учетной записи пользователя: восстановите доступ пользователя к своей учетной записи с помощью процедуры «Забыли пароль» , которая отправляет специальную ссылку по электронной почте, чтобы помочь пользователям быстро восстановить свою учетную запись.
Беспарольный поток: упростите вход и регистрацию пользователя с помощью пароля, а также аутентифицируйте пользователей с помощью мобильного устройства, USB-ключа безопасности или компьютера.
Расширяемая платформа: AuthC поддерживает систему плагинов, позволяющую легко добавлять новые функции для удовлетворения большего количества ваших потребностей в аутентификации.
Authcompanion предоставляет встроенные веб-формы для аутентификации пользователей, включая страницы входа и регистрации.
После того как пользователь проходит аутентификацию с помощью веб-форм AuthC, мы передаем их в ваше веб-приложение.
Полный список веб-форм AuthC см. в Руководстве по веб-формам.
Панель администратора — это инструмент, который позволяет администраторам или владельцам приложений управлять пользователями своего веб-приложения. Он предоставляет ряд функций, которые администраторы могут использовать для создания, редактирования и удаления учетных записей пользователей; все через дружественный и интуитивно понятный интерфейс.
Ознакомьтесь с панелью администратора в документации, чтобы узнать, как получить к ней доступ: Администрирование.
Лучший способ учиться — это делать; вот несколько способов начать.
Вы можете использовать общедоступную демо-версию на demo.authcompanion.com или запустить сервер локально.
AuthC поставляется с готовыми веб-формами, которые помогут вам быстро интегрировать аутентификацию пользователей с вашим веб-приложением.
При работающем сервере AuthC (на предыдущих шагах) сначала начните с регистрации учетной записи, используя эту веб-форму: http://localhost:3002/v1/web/register.
Затем войдите в систему с только что созданной учетной записью, используя свой адрес электронной почты и пароль, в этой веб-форме: http://localhost:3002/v1/web/login. Ответ сервера включает в себя токен доступа для использования при аутентификации в серверных API и перенаправляет пользователя на домашнюю страницу вашего приложения.
Войдите в панель администратора, используя учетные данные, найденные в Руководстве администратора, и обновите профиль пользователя, созданный на предыдущем шаге, изменив его адрес электронной почты (или аналогичное поле).
Ознакомьтесь с Руководством по интеграции, чтобы понять, как ваши интерфейсные приложения и серверные веб-службы взаимодействуют с AuthC.
API аутентификации RESTful обеспечивает работу веб-форм, с помощью которых пользователи проходят аутентификацию в вашем веб-приложении. Важно отметить, что веб-формы сами по себе не охватывают все процессы аутентификации ваших пользователей. Например: обновление токена доступа с истекшим сроком действия потребует взаимодействия с API AuthC в дополнение к использованию веб-отправителей.
Для получения дополнительной информации об API аутентификации ознакомьтесь с документацией здесь: API аутентификации.
API администратора помогает администратору управлять пользователями своего веб-приложения. Он предоставляет ряд функций, с помощью которых администраторы могут программно создавать, редактировать и удалять учетные записи пользователей. API администратора также изначально используется панелью администратора.
Для получения дополнительной информации об API администратора ознакомьтесь с документацией здесь: API администратора.
AuthCompanion распространяется по лицензии Big Time Public License. Эти условия позволяют вам бесплатно использовать и распространять это программное обеспечение в некоммерческих целях и в малом бизнесе, а также гарантировать, что платные лицензии для крупного бизнеса будут доступны на справедливых, разумных и недискриминационных условиях.
Спасибо за дизайн логотипа – Тимоти Ридер (Github)
Тяжелая работа над прототипом и постоянное вдохновение — Тедди Шмитц (Github)
Используйте AuthCompanion, полезного помощника, в своем следующем веб-проекте! ?
