Instalace a konfigurace katalogu

Tento katalog může použít jakákoli organizace, která si přeje vytvořit vlastní seznam digitálních veřejných statků. Veškerý kód je veřejně dostupný v úložišti Product Registry repository.

Upozorňujeme, že tyto pokyny jsou určeny uživatelům, kteří mají technické zázemí a jsou obeznámeni s aplikacemi Rails a nasazením nástroje Docker.

Chcete-li nakonfigurovat a spustit instanci online registru/katalogu, proveďte následující kroky:

• Klonování úložiště registru produktů do adresáře na serveru nebo ve vývojovém prostředí.

• Konfigurace proměnných prostředí pro aplikaci. Aplikace vyžaduje nastavení několika proměnných prostředí. Poskytli jsme ukázkový skript shellu, který nastaví příslušné proměnné pro vývojové, testovací nebo produkční prostředí. Proměnné jsou následující:

• SECRET_KEY_BASE - nastavení jedinečného tajemství nebo hesla. Používá se pro ověření pravosti uživatele

• DATABASE_NAME, DATABASE_USER, DATABASE_PASSWORD - připojovací údaje pro databázi Postgres. Ujistěte se, že tyto hodnoty odpovídají nastavení v souboru docker-compose.yml pro instanci databáze (popsáno níže).

• TEST_DATABASE_NAME, TEST_DATABASE_USER, TEST_DATABASE_PASSWORD - pro spuštění jednotkových nebo integračních testů musí být tyto hodnoty nastaveny a ukazovat na instanci testovací databáze.

• ESRI_CLIENT_ID, ESRI_CLIENT_SECRET - aplikace používá ESRI pro geografická data. Můžete si zaregistrovat účet a přístupový token.

• GOOGLE_TRACKER - vložení sledovacího id pro použití služby Google analytics

• JENKINS_URL, JENKINS_USER, JENKINS_PASSWORD - aby bylo možné používat funkce spouštěče produktu, musí se aplikace připojit k běžící instanci Jenkins.

• MAILGUN_API_KEY, MAILGUN_DOMAIN - aplikace používá mailgun k zasílání e-mailových oznámení uživatelům. Zde použijte údaje o účtu mailgun, abyste tuto funkci povolili.

• CAPTCHA_SITE_KEY, CAPTCHA_SECRET_KEY - hlavní stránka registrace používá Captcha. Chcete-li tuto funkci používat, zadejte své přihlašovací údaje captcha.

• GITHUB_USERNAME, GITHUB_PERSONAL_TOKEN - aplikace bude automaticky načítat data ze všech úložišť GitHub, která jsou připojena k produktům. Za tímto účelem zadejte uživatelské jméno Github a token API.

• Upravte soubor docker-compose.yml a nastavte uživatelské jméno a heslo k databázi.

• Sestavte a spusťte aplikaci pomocí následujících příkazů docker-compose z kořenového adresáře aplikace:

• docker-compose build

• docker-compose up -d

• Chcete-li aplikaci spustit i mimo docker-compose, můžete použít následující příkazy:

• rails db:run_if_no_db && rails db:create_db_with_public_data

• rails db:migrate

• rails assets:precompile RAILS_ENV=production

• rails server -e production

• Po sestavení a spuštění aplikace bude k dispozici na portu 3000. Upozorňujeme, že soubor docker-compose používá k obsluze aplikace pomocí SSL/Port 443 také nginx a certbot. Pokud tyto položky nejsou potřeba, odstraňte je.

• Aplikace očekává, že bude spuštěn server Redis. Server Redis je automaticky spuštěn jako součást docker-compose. Pokud spouštíte katalog ručně, musí být na serveru spuštěn Redis.

• Automaticky se vytvoří výchozí uživatelský účet s právy správce. Přihlašovací údaje jsou admin@admin-user.org/admin-password

• Aplikace také umožňuje nastavit výchozí název domény. Správci webu budou moci být pouze uživatelé, kteří mají e-mailové adresy spojené s touto doménou. Toto nastavení provedete následovně:

• Vytvořte položku organizace pro svou organizaci. Všimněte si, že je pro tuto organizaci vytvořen slug.

• Přejděte na stránku nastavení (<online catalog URL>/settings)

• Vytvořte nové nastavení s názvem „Výchozí organizace“. Hodnota tohoto nastavení bude slug vaší organizace.