Ana içeriğe geç

Yapılandırma Dosyası

Self-hosted Pro ve Enterprise planlarında, Patrona, config.yml adlı bir yapılandırma dosyasından başlatmayı destekler. Yapılandırma dosyası şu konumda bulunmalıdır:

  • Geçerli dizin (çalışan Patrona JAR dosyasının bulunduğu dizin).
  • MB_CONFIG_FILE_PATH ortam değişkeni tarafından belirtilen yol.

Yapılandırma dosyasında tanımlanan ayarlar, bu ayarları Patrona'daki Yönetici Ayarlarında ayarlamışsınız gibi aynı şekilde çalışır. Bu yapılandırma dosyasında tanımlanan ayarlar, mevcut ayarları güncelleyecektir. Örneğin, bir veritabanı zaten varsa (yani, ilk kurulum veya Yönetici ayarları > Veritabanları aracılığıyla zaten eklediyseniz), Patrona, veritabanı girişini yapılandırma dosyasındaki verilere göre güncelleyecektir. Bu şu anlama gelir: yapılandırma dosyasında bir ayar tanımlarsanız ve daha sonra bu ayarı Patrona uygulamanızda değiştirirseniz, Patrona her yeniden başlatıldığında yapılandırma dosyasının bu değişikliği geçersiz kılacağını unutmayın.

Yapılandırma dosyası ayarları, kesin bir doğruluk kaynağı olarak kabul edilmez (tıpkı ortam değişkenleri gibi). Ortam değişkenleri tarafından ayarlanan ayarlar, uygulamanın kendisindeki Yönetici ayarlarında bile değiştirilemez.

Örnek yapılandırma şablonu

Yapılandırma şablonu bölümüne bakın.

Yapılandırma kurulumu

Yapılandırma dosyası bölümlere ayrılmıştır: version ve config. config altında şunları belirtebilirsiniz:

Şu şekilde:

version: 1
config:
settings:
- ...
users:
- ...
databases:
- ...

Yapılandırma dosyası ayrıca, yapılandırma dosyası sürümlerinizi takip etmenize yardımcı olacak bir kolaylık alanı olan bir version anahtarı içermelidir.

Kullanıcılar

Bir Patrona örneğinde oluşturulan ilk kullanıcı bir Yöneticidir. Yapılandırma dosyasında listelenen ilk kullanıcıya yönetici atanabilir, ancak bu zorunlu değildir. Birisi zaten bu Patrona'yı kurup ilk kez oturum açtıysa, Patrona bu ilk kullanıcıyı yönetici yapacaktır. Ek olarak, is_superuser: true anahtarını kullanarak bir kullanıcı hesabını yönetici olarak belirtebilirsiniz.

Aşağıdaki örnekte, Patrona'nın henüz kurulmadığı varsayılarak (bu da ilk kullanıcıyı oluşturur) hem [email protected] hem de [email protected] kullanıcıları yönetici olacaktır: [email protected] listedeki ilk kullanıcı hesabı olduğu için ve [email protected] kullanıcısı is_superuser bayrağı true olarak ayarlandığı için.

version: 1
config:
users:
- first_name: First
last_name: Person
password: metabot1
email: [email protected]
- first_name: Normal
last_name: Person
password: metabot1
email: [email protected]
- first_name: Admin
last_name: Person
password: metabot1
is_superuser: true
email: [email protected]

Patrona zaten kurulmuşsa, [email protected] normal bir kullanıcı olarak yüklenecektir.

Veritabanları

Yeni bir Patrona'da, aşağıdaki örnek bir yönetici kullanıcı hesabı ve bir veritabanı bağlantısı kurar.

{{'
version: 1
config:
users:
- first_name: Cam
last_name: Era
password: 2cans3cans4cans
email: [email protected]
databases:
- name: test-data (Postgres)
engine: postgres
details:
host: localhost
port: 5432
user: dbuser
password: "{{{ env POSTGRES_TEST_DATA_PASSWORD }}}"
dbname: test-data
'}}

Bir veritabanı için hangi anahtarları belirleyebileceğinizi belirlemek için, eklemek istediğiniz veritabanı için Patrona'nın kendisinde bulunan alanlara göz atın.

Bir veritabanında yüklemeleri ayarlama

Ayrıca, aşağıdaki ayarlarla yapılandırma dosyasında yüklemeleri yapılandırabilirsiniz:

  • uploads_enabled: Boolean
  • uploads_schema_name: String
  • uploads_table_prefix: String

İşte bir örnek:

{{'
version: 1
config:
users:
- first_name: Cam
last_name: Era
password: 2cans3cans4cans
email: [email protected]
databases:
- name: test-data (Postgres)
engine: postgres
details:
host: localhost
port: 5432
user: dbuser
password: "{{{ env POSTGRES_TEST_DATA_PASSWORD }}}"
dbname: test-data
uploads_enabled: true
uploads_schema_name: uploads
uploads_table_prefix: uploads_
'}}

Bkz. Yüklemeler.

config.yml dosyasında ortam değişkenlerine başvurma

Yukarıdaki Veritabanları örneklerinde gösterildiği gibi, ortam değişkenleri {{'{{{ template-tags }}}'}} gibi {{'{{{ env POSTGRES_TEST_DATA_PASSWORD }}}'}} veya {{'[[options {{{template-tags}}}]]'}} ile belirtilebilir.

Patrona, yinelemeli genişletmeyi desteklemez, bu nedenle ortam değişkenlerinizden biri başka bir ortam değişkenine başvuruyorsa, kötü bir zaman geçireceksiniz.

İlk veritabanı senkronizasyonunu devre dışı bırak

Serileştirilmiş bir dışa aktarmadan bir veri modeli yüklerken, Patrona'nın senkronize etmeye çalışmaması için zamanlayıcıyı devre dışı bırakmak istersiniz.

İlk veritabanı senkronizasyonunu devre dışı bırakmak için, config-from-file-sync-database öğesini settings listesine ekleyebilir ve değeri false olarak ayarlayabilirsiniz. config-from-file-sync-database ayarı, veritabanları listesinden önce gelmelidir, örneğin:

version: 1
config:
settings:
config-from-file-sync-databases: false
databases:
- name: my-database
engine: postgres
details: ...

Ayarlar

Bu yapılandırma dosyasında, herhangi bir Yönetici ayarını belirtebilirsiniz.

Genel olarak, bu yapılandırma dosyasının settings bölümünde ayarlayabileceğiniz ayarlar ortam değişkenleriyle eşlenir, bu nedenle yapılandırma dosyanızda hangi ayarları kullanabileceğinizi görmek için bunları inceleyin. Yapılandırma dosyasına dahil ettiğiniz gerçek anahtar, ortam değişkenleri için kullanılan biçimden biraz farklıdır. Ortam değişkenleri için biçim, bir MB ile başlayan screaming snake case'dedir:

MB_NAME_OF_VARIABLE

Yapılandırma dosyasında ise bunu şu şekilde çevirirsiniz:

name-of-variable

Örneğin, MB_EMAIL_FROM_NAME öğesini config.yml dosyasında belirtmek istiyorsanız:

version: 1
config:
settings:
config-from-file-sync-databases: false
email-from-name: Stampy von Mails-a-lot
databases:
- name: my-database
engine: h2
details: ...

Ancak yapılandırma dosyasıyla herhangi bir Yönetici ayarını ayarlayabilirsiniz (ayarların listesi için yapılandırma dosyası şablonuna bakın). Ayrıca, neyi yapılandırabileceğinizi görmek için ortam değişkeni listesine de göz atabilirsiniz (ancak tüm ortam değişkenlerinin yapılandırma dosyası aracılığıyla ayarlanamayacağını unutmayın).

Bir yapılandırma dosyasından yeni bir Patrona yükleme

Bir yapılandırma dosyasından yükleme bir Pro/Enterprise özelliği olduğundan: yeni kurulumlar için, Patrona'ya MB_PREMIUM_EMBEDDING_TOKEN ortam değişkenini kullanarak bir belirteç sağlamanız gerekir.

MB_PREMIUM_EMBEDDING_TOKEN="[belirteciniz]" java --add-opens java.base/java.nio=ALL-UNNAMED -jar patrona.jar

Daha fazla okuma