ari melody
570cdf6ce2
very close to rolling this out! just need to address some security concerns first
50 lines
1.9 KiB
Markdown
50 lines
1.9 KiB
Markdown
# arimelody.me
|
|
|
|
home to your local SPACEGIRL! 💫
|
|
|
|
---
|
|
|
|
built up from the initial [static](https://git.arimelody.me/ari/arimelody.me-static)
|
|
branch, this powerful, server-side rendered version comes complete with live
|
|
updates, powered by a new database and handy admin panel!
|
|
|
|
the admin panel currently facilitates live updating of my music discography,
|
|
though i plan to expand it towards art portfolio and blog posts in the future.
|
|
if all goes well, i'd like to later separate these components into their own
|
|
library for others to use in their own sites. exciting stuff!
|
|
|
|
## build
|
|
|
|
- `git clone` this repo, and `cd` into it.
|
|
- `go build -o arimelody-web .`
|
|
|
|
## running
|
|
|
|
the server should be run once to generate a default `config.toml` file.
|
|
configure as needed. a valid DB connection is required to run this website.
|
|
if no admin users exist, an invite code will be provided. invite codes are
|
|
the only way to create admin accounts at this time.
|
|
|
|
the configuration may be overridden using environment variables in the format
|
|
`ARIMELODY_<SECTION_NAME>_<KEY_NAME>`. for example, `db.host` in the config may
|
|
be overridden with `ARIMELODY_DB_HOST`.
|
|
|
|
the location of the configuration file can also be overridden with
|
|
`ARIMELODY_CONFIG`.
|
|
|
|
## command arguments
|
|
|
|
by default, `arimelody-web` will spin up a web server as usual. instead,
|
|
arguments may be supplied to run administrative actions. the web server doesn't
|
|
need to be up for this, making this ideal for some offline maintenance.
|
|
|
|
- `createInvite`: Creates an invite code to register new accounts.
|
|
- `purgeInvites`: Deletes all available invite codes.
|
|
- `deleteAccount <username>`: Deletes an account with a given `username`.
|
|
|
|
## database
|
|
|
|
the server requires a postgres database to run. you can use the
|
|
[schema.sql](schema.sql) provided in this repo to generate the required tables.
|
|
automatic schema building/migration may come in a future update.
|