diff --git a/README.md b/README.md index bc1bab5..af6f0cf 100644 --- a/README.md +++ b/README.md @@ -23,10 +23,10 @@ docker-compose up -d ## Configuration environment file -All configuration options are defined in .env, to be created in the same directory as this readme. - -An example configuration: +All configuration options are defined in crablog.env, an example configuration is provided. +When not using Docker you may have to add crablog.env to your startup script or define the variables there. +`crablog.env` ``` USERNAME=yourusername EMAIL=me@mydomain.tld diff --git a/crablog.env b/crablog.env index 1bacdfe..0342b21 100644 --- a/crablog.env +++ b/crablog.env @@ -1,6 +1,9 @@ -SUBMIT_TOKEN=mysupersecretpw +USERNAME=yourusername +EMAIL=me@mydomain.tld BIND_PORT=8000 -USERNAME= -EMAIL= -TWITTER_ACCOUNT= -GITHUB_ACCOUNT= \ No newline at end of file +SUBMIT_TOKEN=Submit!123 # token needed for submitting +GITHUB_ACCOUNT=usernam3 +TWITTER_ACCOUNT=usernam3 +MASTODON_ACCOUNT=usernam3@mastodon.social +REDDIT_ACCOUNT=usernam3 +DISCORD_ACCOUNT=usernam3 \ No newline at end of file