shibao/cannery
shibao/cannery
1
2
Fork 1
Code Issues 16 Pull Requests Projects 1 Releases 36 Wiki Activity
The self-hosted firearm tracker app
94 Commits 3 Branches 37 Tags 13 MiB
Elixir 79.3%
HTML 18.3%
JavaScript 1.4%
SCSS 0.8%
Dockerfile 0.2%
a778f5a61f
Go to file
shibao a778f5a61f rename to cannery
2023-02-25 16:02:08 -05:00
assets rename to cannery 2023-02-25 16:02:08 -05:00
config rename to cannery 2023-02-25 16:02:08 -05:00
lib rename to cannery 2023-02-25 16:02:08 -05:00
priv rename to cannery 2023-02-25 16:02:08 -05:00
test rename to cannery 2023-02-25 16:02:08 -05:00
.credo.exs use credo style 2023-02-04 17:32:40 -05:00
.drone.yml rename to cannery 2023-02-25 16:02:08 -05:00
.formatter.exs update deps 2023-01-07 21:00:14 -05:00
.gitignore rename to cannery 2023-02-25 16:02:08 -05:00
.tool-versions improve ci 2023-02-05 10:24:47 -05:00
CONTRIBUTING.md rename to cannery 2023-02-25 16:02:08 -05:00
docker-compose.yml rename to cannery 2023-02-25 16:02:08 -05:00
Dockerfile rename to cannery 2023-02-25 16:02:08 -05:00
mix.exs rename to cannery 2023-02-25 16:02:08 -05:00
mix.lock add qr code for invite link 2023-01-26 00:46:21 -05:00
README.md rename to cannery 2023-02-25 16:02:08 -05:00

README.md

Cannery

Cannery is a local business aggregation site helping you to shop locally by providing a one-stop-shop for your local community. Set your profile and start shopping today!

Features

  • User Registration/Sign in via phx_gen_auth
  • Dockerfile and example docker-compose.yml
  • Automatic migrations in MIX_ENV=prod or Docker image
  • JS linting with standard.js, HEEx linting with heex_formatter

Installation

  1. Install Docker Compose or alternatively Docker Desktop on your machine.
  2. Copy the example docker-compose.yml. into your local machine where you want. Bind mounts are created in the same directory by default.
  3. Set the configuration variables in docker-compose.yml. You'll need to run docker run -it shibaobun/cannery /app/priv/random.sh to generate a new secret key base.
  4. Use docker-compose up or docker-compose up -d to start the container!

The first created user will be created as an admin.

Configuration

You can use the following environment variables to configure Cannery in docker-compose.yml.

  • HOST: External url to generate links with. Must be set with your hosted domain name! I.e. cannery.mywebsite.tld
  • PORT: Internal port to bind to. Defaults to 4000. Must be reverse proxied!
  • DATABASE_URL: Controls the database url to connect to. Defaults to ecto://postgres:postgres@cannery-db/cannery.
  • ECTO_IPV6: If set to true, Ecto should use ipv6 to connect to PostgreSQL. Defaults to false.
  • POOL_SIZE: Controls the pool size to use with PostgreSQL. Defaults to 10.
  • SECRET_KEY_BASE: Secret key base used to sign cookies. Must be generated with docker run -it shibaobun/cannery mix phx.gen.secret and set for server to start.
  • REGISTRATION: Controls if user sign-up should be invite only or set to public. Set to public to enable public registration. Defaults to invite.
  • LOCALE: Sets a custom default locale. Defaults to en_US.
  • SMTP_HOST: The url for your SMTP email provider. Must be set
  • SMTP_PORT: The port for your SMTP relay. Defaults to 587.
  • SMTP_USERNAME: The username for your SMTP relay. Must be set!
  • SMTP_PASSWORD: The password for your SMTP relay. Must be set!
  • SMTP_SSL: Set to true to enable SSL for emails. Defaults to false.
  • EMAIL_FROM: Sets the sender email in sent emails. Defaults to no-reply@HOST where HOST was previously defined.
  • EMAIL_NAME: Sets the sender name in sent emails. Defaults to "Cannery".

Build Status