Настройка Studio для веб-разработчиков

Скачайте пакет Studio

Войдите в Maxisnap, используя аккаунт, у которого есть Studio, затем:

• В Windows: в Maxisnap откройте Настройки → Аккаунт → Мастер настройки Studio, нажмите «Начать работу», затем «Скачать панель управления». Maxisnap сохраняет ZIP-архив Studio в папку «Загрузки» и открывает эту папку.
• На Mac: в Maxisnap откройте Settings → Welcome & Help → Studio Setup Guide, нажмите «Get Started», затем «Download Dashboard». Maxisnap сохраняет ZIP-архив Studio в папку «Загрузки».

Распакуйте ZIP-архив. В Windows щёлкните его правой кнопкой мыши и выберите «Извлечь все». На Mac дважды щёлкните его.

Maxisnap-Studio-v<version>/
  Maxisnap Studio - Start Here.html   guided setup (branding + every route)
  snaps/                              PHP edition: upload this folder to a web host
  cloudflare/                         Cloudflare Workers edition (Worker + R2 + D1)
    deploy/cli.mjs                    deploys it through the Cloudflare API (Node 20+)
  docs/Developer guide.html           architecture, upload API, security, updates
  docs/Cloudflare setup - technical brief.html
  AGENTS.md                           instructions for AI coding assistants

Полное руководство Developer guide охватывает архитектуру, API загрузки, ключи и роли, модель безопасности и устранение неполадок. Оно находится в файле docs/Developer guide.html в пакете Studio.

Вариант на PHP: загрузка и завершение настройки

1. Загрузите папку snaps в корневую папку сайта вместе со скрытыми файлами .htaccess, чтобы получился путь public_html/snaps/index.php. Архив snaps.zip с вашим оформлением, созданный на странице Start Here, работает так же: распакуйте его на месте и не допускайте вложенности snaps/snaps.
2. Откройте https://yourcompany.com/snaps/ один раз. Страница настройки проверяет PHP и права доступа к папке и предлагает ключ администратора из 40 символов; в ключе должно быть не менее 16 символов. Скопируйте его, затем нажмите «Create my dashboard».
3. На nginx воспроизведите правила маршрутизации и запрета из snaps/.htaccess. Не открывайте публичный доступ к uploads, data и branding.

Страница настройки создаёт файл your-settings.php, который сохраняется при обновлениях:

'dashboard_key' => '…',          // the Admin key; the setup page writes it
'base_url'      => 'https://yourcompany.com/snaps',  // the address setup was opened at; fix it here if share links come out wrong
'max_upload_mb' => 500,          // your host's PHP limits still apply

Вариант на Cloudflare: развёртывание из терминала

Входящий в комплект CLI сначала считывает данные аккаунта, затем показывает план: что он создаст и чего не тронет, — и отказывается использовать имена, которые уже заняты. Если развёртывание прервалось на полпути, повторный запуск той же команды продолжит его, и ничего не будет создано дважды.

cd cloudflare
# Option 1: the bundled CLI (Node 20+; plan first, then --yes). PowerShell:
$env:CLOUDFLARE_API_TOKEN = "<token: Account Settings Read; Workers Scripts, R2 and D1 Edit;
                              for --zone/--hostname also Zone Read, DNS Read, Workers Routes Read>"
node deploy/cli.mjs whoami
node deploy/cli.mjs plan --account <account id> --name snaps
#   no workers.dev name on the account yet? The plan asks you to "Choose your free
#   workers.dev name": add --subdomain <your-company> to both commands (account-wide).
#   A subdomain of your domain as well: add --zone <zone id> --hostname snaps.example.com
node deploy/cli.mjs deploy --account <account id> --name snaps --yes
#   prints the Studio address and the Admin key once, and writes deployment.json here

# Option 2: plain Wrangler (create the bucket and database, set their ids in wrangler.jsonc)
npm install
npx wrangler r2 bucket create maxisnap-studio-media
npx wrangler d1 create maxisnap-studio
npx wrangler secret put ADMIN_KEY
npm run sync
npx wrangler deploy

Развёртывание один раз выводит адрес Studio и ключ администратора и записывает deployment.json в папку, из которой запущено. Сохраните этот файл: он нужен командам update и remove.

Проверьте, что всё работает

curl.exe -s -H "X-Dashboard-Key: <Admin key>" https://<studio address>/api/health.php
# {"ok":true,"app":"Maxisnap Studio","version":"…"}   the Cloudflare edition adds "edition":"cloudflare"

Затем откройте адрес Studio в браузере и войдите с ключом администратора. 401 означает неверный ключ; 404 — неверный адрес или папку.

Подключите Maxisnap

• Maxisnap для Windows: откройте Настройки → Аккаунт → Мастер настройки Studio, нажмите «Начать работу», затем нажимайте «Далее», пока не дойдёте до шага 4 — «Подключите Maxisnap». Вставьте адрес вашего Studio и ключ, нажмите «Проверить подключение», затем «Далее», а на последней странице — «Завершить и сохранить». Подойдёт ключ администратора, полученный при настройке, а также код загрузки из раздела People & access в вашей панели управления.
• Maxisnap для Mac: откройте Settings → Welcome & Help → Studio Setup Guide и выберите «I already have a dashboard». Вставьте адрес вашего Studio и ключ, нажмите «Test Connection», затем «Next», затем «Finish & Save».

Узнайте об API загрузки

• Приложения Maxisnap отправляют загрузки на api/upload.php с заголовком X-Dashboard-Key. Принимаются изображения (PNG, JPG, GIF и WebP) и видео (MP4, WebM и MOV).
• Maxisnap для Windows и Maxisnap для Mac отправляют каждую загрузку в Studio на Cloudflare одним запросом, а Studio принимает такие запросы для файлов размером до 25 МБ.
• В варианте на Cloudflare есть также API загрузки по частям для больших файлов; он описан в Developer guide: api/upload/start, part и complete.
• Страницы общего доступа и их медиафайлы используют эти пути; все остальные пути внутренние: /<slug> /<slug>.<ext>

Обновите или удалите его позже

PHP: замените только файлы, перечисленные в snaps/How to update.txt, затем очистите кэш хостинга и CDN. Снимки, пользователи, оформление и настройки сохраняются.

Cloudflare: выполните эти команды из папки cloudflare нового пакета, скопировав в неё старый файл deployment.json.

# Update: from a newer package's cloudflare folder, with the old deployment.json copied in
node deploy/cli.mjs update --record deployment.json --yes
# New Admin key (shown once):
node deploy/cli.mjs update --record deployment.json --yes --new-admin-key
# Remove the custom domain and the Worker; the bucket and database (the captures) stay
node deploy/cli.mjs remove --record deployment.json --yes
# Also delete every capture: cannot be undone
node deploy/cli.mjs remove --record deployment.json --yes --delete-data

Прочитайте техническое описание Cloudflare: все ресурсы, разрешения и вызовы API.