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
326 Commits 3 Branches 37 Tags 13 MiB
Elixir 79.3%
HTML 18.3%
JavaScript 1.4%
SCSS 0.8%
Dockerfile 0.2%
9db6b2c316
Go to file
shibao 9db6b2c316
All checks were successful
continuous-integration/drone/push Build is passing
Details
Translated using Weblate (German) 
Currently translated at 100.0% (33 of 33 strings)

Translation: cannery/actions
Translate-URL: https://weblate.bubbletea.dev/projects/cannery/actions/de/
2022-04-19 21:32:54 +00:00
assets display inline block, add min width to buttons and links 2022-03-28 23:56:15 -04:00
config make app responsive 2022-02-16 00:10:02 -05:00
lib bump version 2022-03-28 23:58:16 -04:00
priv Translated using Weblate (German) 2022-04-19 21:32:54 +00:00
test fix credo 2022-03-28 23:05:12 -04:00
.credo.exs fix credo 2022-03-28 23:05:12 -04:00
.drone.yml make drone cache persistent 2022-03-04 23:36:19 -05:00
.formatter.exs reenable heex_formatter 2022-02-01 01:08:18 -05:00
.gitignore add .vscode dir to gitignore 2022-01-27 00:57:03 -05:00
.tool-versions add heex formatter 2022-01-23 22:50:06 -05:00
CHANGELOG.md bump version 2022-03-28 23:58:16 -04:00
CONTRIBUTING.md add contributers list to contributing guide 2022-02-13 21:39:15 -05:00
docker-compose.yml fix docker compose 2022-02-18 17:47:30 -05:00
Dockerfile fix docker versions 2022-02-18 17:44:58 -05:00
home.png add preview to readme 2022-02-19 00:51:01 -05:00
LICENSE.md - add translation status to readme and contributing guide 2022-02-07 23:31:21 -05:00
mix.exs bump version 2022-03-28 23:58:16 -04:00
mix.lock mix format with new version 2022-02-17 21:25:08 -05:00
README.md fix readme image embed 2022-02-19 00:55:37 -05:00

README.md

Cannery

screenshot

The self-hosted firearm tracker website.

  • Easy to Use: Cannery lets you easily keep an eye on your ammo levels before and after range day
  • Secure: Self-host your own instance, or use an instance from someone you trust. Your data stays with you, period
  • Simple: Access from any internet-capable device

Features

  • Create containers to store your ammunition, and tag them with custom tags
  • Add ammunition types to Cannery, and then ammunition groups to your containers
  • Stage groups of ammo for range day and record your ammo usage
  • Invitations via invite tokens or public registration

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.

Reverse proxy

Finally, reverse proxy to port 4000 of the container. If you're using a reverse proxy in another docker container, you can reverse proxy to http://cannery:4000. Otherwise, you'll need to modify the docker-compose.yml to bind the port to your local machine.

For instance, instead of

expose:
  - "4000"

use

ports:
  - "127.0.0.1:4000:4000"

and reverse proxy to http://localhost:4000.

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 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".

Contribution

Contributions are greatly appreciated, no ability to code needed! You can browse the Contribution Guide to learn more.

I can be contacted at shibao@bubbletea.dev, or on the fediverse at @shibao@misskey.bubbletea.dev. Thank you!

License

Cannery is licensed under AGPLv3 or later. A copy of the latest version of the license can be found at LICENSE.md.

Build Status translation status