Plume の設定

PostgreSQLを使用している場合は、Plume 用のデータベースを作成する必要があります。

service postgresql start
su - postgres
createuser -d -P plume
createdb -O plume plume

Plume を起動する前に、.env という設定ファイルを作成する必要があります。 このファイルはPlumeを起動するディレクトリーと同じ所に置く必要があります。(前の手順に従った場合 ~/Plume です)。 ソースからインストールしている場合は、 cp .env.sample .env を使用して作成できます。 Here is a sample of what you should put inside for GNU/Linux and Mac OS X systems.

# データベースアドレス
# SQliteを使用している場合はデータベースファイルのフルパスを使用(例: `plume.db`)
# Windows user's paths are backslashes, change them to forward slashes

# For PostgreSQL: migrations/postgres
# For SQlite: migrations/sqlite

# The domain on which your instance will be available

# Secret key used for private cookies and CSRF protection
# You can generate one with `openssl rand -base64 32`

# Mail settings
# If you don't want to setup a mail server and/or address for plume
# and don't plan to use the "password reset" feature,
# you can comment these lines.

.envに記述できる情報の詳細については、 環境変数に関するドキュメント を参照してください。

Now we need to run migrations. Migrations are scripts used to update the database. To run the migrations, you can do for GNU/Linux and Mac OS X:

plm migration run

If you are using Windows and DATABASE of sqlite, you will need to copy the sqlite3.dll from “C:\ProgramData\chocolatey\lib\SQLite\tools” to where plm.exe and plume.exe were compiled: copy "C:\ProgramData\chocolatey\lib\SQLite\tools\sqlite3.dll" "C:\Users\%USERNAME%\.cargo\bin\sqlite3.dll"

Now you may run the migrations: plm migration run

Migrations should be run after each update. When in doubt, run them.

You will also need to initialise search index:

plm search init

After that, you’ll need to setup your instance, and the admin’s account.

plm instance new
plm users new --admin

Note if you want to use LDAP: you should still create an administrator account, at least to give admin rights to your own LDAP account once it’s registered.

On Windows, there might be an error creating the admin user. To get around this, you need to run: plm users new --admin -n "adminusername" -N "Human Readable Admin Name" -b "Biography of Admin here" -p hackmeplease

For more information about these commands, and the arguments you can give them, check out their documentation.

Now that Plume is configured, if you are in a production environment you probably want to configure your init system to make it easier to manage.

Configure init system