Small, lightweight pastebin+URL shortener written in Elixir using the Phoenix framework.
Go to file
SphericalKat 8f4672b516
refactor(auth): use heex templates
Signed-off-by: SphericalKat <amolele@gmail.com>
2021-10-07 05:58:00 +05:30
assets chore(deps): bump phoenix and other package versions 2021-10-07 05:29:22 +05:30
config refactor(auth): use heex templates 2021-10-07 05:58:00 +05:30
lib refactor(auth): use heex templates 2021-10-07 05:58:00 +05:30
native/ketbin_utils_syntax chore(native): run cargo fmt 2021-08-17 03:24:30 +05:30
priv chore: prepare for prod 2021-08-14 01:19:00 +05:30
test refactor(auth): use heex templates 2021-10-07 05:58:00 +05:30
.dockerignore fix(build): add rust and cargo dependency to builder image 2021-08-17 03:22:52 +05:30
.formatter.exs chore(git): Initial commit 2021-08-09 14:18:23 +05:30
.gitignore refactor(config): use secret files in dev mode 2021-08-21 16:47:31 +05:30
Dockerfile fix(build): add rust and cargo dependency to builder image 2021-08-17 03:22:52 +05:30
Makefile chore(build): add makefile 2021-08-14 14:55:22 +05:30
mix.exs refactor(auth): use heex templates 2021-10-07 05:58:00 +05:30
mix.lock chore(deps): bump phoenix and other package versions 2021-10-07 05:29:22 +05:30
README.md chore(deps): bump phoenix and other package versions 2021-10-07 05:29:22 +05:30
sample.env chore: add sample env file 2021-09-16 23:50:58 +05:30
startup.sh chore: prepare for prod 2021-08-14 01:19:00 +05:30

Katbin

To start your Phoenix server:

  • Copy config/dev.secret.sample.exs to config/dev.secret.exs
  • Fill in the SMTP and database configuration in config/dev.secret.exs
  • Install dependencies with mix deps.get
  • Create and migrate your database with mix ecto.setup
  • Install Node.js dependencies with npm install inside the assets directory
  • Start Phoenix endpoint with mix phx.server

Now you can visit localhost:4000 from your browser.

Self hosting

We recommend using our official docker image. If you wish to build your own docker image, the provided Dockerfile should work out of the box. If you run into any problems, please open an issue.

Populating the environment

Copy the provided sample.env file to .env

cp sample.env .env

Fill in this new file with the required environment variables.

Using the official docker image

docker run --env-file .env atechnohazard/katbin-elixir

Building the docker image

git clone https://github.com/SphericalKat/katbin
cd katbin
docker build -t <username>/katbin .

Running the built docker image

docker run --env-file .env <username>/katbin

For other methods of self hosting, please check the official Phoenix deployment guides.

Learn more