скрыть ключ API для страницы Github

Короче нет. Если ваше репозиторий GitHub является общедоступным, все его активы являются общедоступными. Вы можете сделать репозиторий закрытым, и он по-прежнему будет публиковаться на страницах GitHub, если он назван в соответствии с соглашением username.github.io или если у него есть ветка gh-pages. Хотя это вариант, это не обязательно правильно.

Если ваш ключ находится в репозитории GitHub Pages, похоже, он используется для вызовов API на стороне клиента в JavaScript. Если это так, ваш токен аутентификации является общедоступным, независимо от того, находится ли он в вашем общедоступном репо или отправлен в ваших клиентских файлах в браузер. Обычно это нормально. Сторонний API мог сгенерировать токен аутентификации на основе домена вашего веб-сайта и ограничить вызовы с использованием этого токена на страницы, происходящие из вашего домена. В противном случае им может потребоваться токен аутентификации только для регистрации запросов и мониторинга использования.

Если токен аутентификации действительно должен быть частным, вам может потребоваться написать частный серверный код для вызова стороннего API. После этого ваш сайт GitHub Pages может попасть в ваш сервис за необходимыми данными. Мне приходилось делать это раньше, когда у веб-API были проблемы с безопасностью, но мне все еще нужно было получать неконфиденциальные данные со стороны клиента.

Короче говоря, да, вы можете сохранить токен аутентификации в переменной среды и использовать gitignore в файле .env, чтобы скрыть токен аутентификации в публичное репо. Обновите токен аутентификации в клиентском API, затем отправьте изменения в общедоступное репо и повторно разверните свои обновления в ветке gh-pages. Ниже я привел пример этого процесса.

ПРИМЕЧАНИЕ

Если вы зафиксировали пароль или ключ API, измените его! Если вы зафиксировали ключ, сгенерируйте новый. Ознакомьтесь с общими рекомендациями на GitHub < / а>.

Если вы используете React для своего приложения, ПРОПУСТИТЕ шаги 1 и 2, поскольку React уже предустановлен с пользовательскими переменными среды. См. Ссылку Create React App.

Полное объяснение можно найти ниже:

1. Установите зависимость dotenv в корневой каталог приложения (в этом примере будет использоваться Node.js). Ссылка npm, выполните команду:

npm install dotenv

2. Добавьте код ниже, чтобы импортировать операторы в файл index.js.

require('dotenv').config();

3. Создайте файл .env в корневом каталоге приложения и добавьте токен аутентификации в качестве переменной. Обратите внимание, что при использовании React вы должны добавить к имени переменной REACT_APP_

AUTH_TOKEN=987asc8iks0lenv7

4. Используйте console.log () в process.env, чтобы проверить, правильно ли сохранена переменная.

console.log(process.env.AUTH_TOKEN);

5. Обновите все ссылки на токен аутентификации в коде приложения.

OLD VARIABLE: const auth_token = '987asc8iks0lenv7';

NEW VARIABLE: const auth_token = process.env.AUTH_TOKEN;

6. Создайте и добавьте файл .gitignore в корневой каталог приложения и добавьте код ниже, чтобы git игнорировал .env < / strong> файл, в котором хранится токен аутентификации.