| English | Русский |
Требуется PHP 8.4.1+ и расширение cURL. Noter отправляет заметки на настроенный HTTP(S)-приёмник; используйте HTTPS для удалённых серверов.
Вы можете установить Noter, выполнив следующую команду, где https://your.custom.url и your_key_value - URL и ключ
вашего сервера-хранилища.
curl -fsSLo /tmp/noter-install.sh --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/localzet/noter/main/install.sh
less /tmp/noter-install.sh
sudo bash /tmp/noter-install.sh -u "https://your.custom.url"
Установщик запросит API key без отображения ввода. Ключ также можно передать через -k, но аргументы команды могут попасть в историю shell и список процессов. Установщик не печатает URL или ключ, сохраняет конфигурацию с правами только для root и проверяет TLS при загрузке бинарного файла.
Чтобы создать заметку, просто выполните команду:
noter "Ваш текст заметки"
Или вы можете передать текст через стандартный входной поток:
echo "Ваш текст заметки" | noter
При успехе Noter выводит HTTP-статус, но не печатает тело ответа сервера. Тело ответа не сохраняется и ограничено 8 КиБ; при сетевой ошибке, слишком большом ответе или HTTP-статусе вне диапазона 2xx команда завершается с ошибкой.
После установки Noter, файл конфигурации будет создан в /usr/local/noter/noter.zconf.
Этот файл будет содержать ваши настройки URL и ключа:
NOTER_URL = "https://your.custom.url"
NOTER_KEY = "your_key_value"
При установке укажите обязательный флаг
-u. API-ключ можно передать через-k, но тогда он может сохраниться в истории команд или списке процессов. В интерактивном терминале безопаснее ввести ключ в скрытом приглашении.
Для URL сервера используйте HTTPS: API-ключ отправляется в заголовке X-API-KEY. Обычный HTTP разрешён только для loopback IP-адресов (127.0.0.0/8 и ::1), например в локальных интеграционных тестах. Noter передаёт исходный текст в поле JSON content. Получающее приложение отвечает за кодирование вывода с учётом контекста: при отображении заметки в HTML экранируйте её и не вставляйте пользовательский текст как сырой HTML.
Чтобы ваш сервер мог обрабатывать заметки, он должен принимать POST-запросы с содержимым заметок. Вот пример схемы работы бэкенда:
<?php
// Конфигурация
$apiKey = "your_key_value";
$database = []; // Пример хранилища (может быть заменено на базу данных)
// Проверка метода запроса
if ($_SERVER['REQUEST_METHOD'] === 'POST') {
$headers = getallheaders();
// Проверка API ключа
if (isset($headers['X-API-KEY']) && $headers['X-API-KEY'] === $apiKey) {
// Получение содержимого запроса
$data = json_decode(file_get_contents('php://input'), true);
if (isset($data['content'])) {
// Сохранение заметки (в примере в массиве, может быть заменено на базу данных)
$database[] = $data['content'];
echo json_encode(['status' => 200, 'message' => 'Note saved']);
} else {
echo json_encode(['status' => 400, 'message' => 'Invalid content']);
}
} else {
echo json_encode(['status' => 403, 'message' => 'Invalid API key']);
}
} else {
echo json_encode(['status' => 405, 'message' => 'Invalid request method']);
}
<?php // config/route.php
use Triangle\Database\Manager;
use Triangle\Exception\BusinessException;
use Triangle\Http\{Request, Response};
use Triangle\Router;
Router::post('/save', function (Request $request): Response {
// Конфигурация
$apiKey = "your_key_value";
// Проверка API ключа
if ($request->header('X-API-KEY') === $apiKey) {
if ($content = $request->post('content')) {
// Генерация UUID для идентификации записи
$id = generateId();
// Сохранение заметки в базе данных
Manager::table('Noter')->insert(compact('id', 'content'));
// Возврат в консоль идентификатора заметки
return response($id);
} else {
throw new BusinessException('Invalid content', 400);
}
} else {
throw new BusinessException('Invalid API key', 403);
}
});
Copyright © 2016-2026 Localzet Group. All rights reserved.