sphericalkat/katbin
1
0
Fork 0
Code Issues 5 Pull Requests 12 Actions Packages Projects Releases Wiki Activity
Small, lightweight pastebin+URL shortener written in Elixir using the Phoenix framework.
80 Commits 14 Branches 0 Tags 968 KiB
Elixir 80.5%
HTML 10.6%
CSS 4.8%
JavaScript 2.5%
Dockerfile 0.6%
Other 0.9%
b76d005a22
Go to file
Amogh Lele b76d005a22
ci(actions): set up automated deploys using github actions 
Signed-off-by: Amogh Lele <amogh@dyte.io>
2022-05-23 09:22:27 +05:30
.github/workflows ci(actions): set up automated deploys using github actions 2022-05-23 09:22:27 +05:30
assets feat(shorten): improve ux by showing users what the shortened url is 2022-05-21 16:21:02 +05:30
config fix(config): enable ipv6 for fly databases 2022-05-06 21:14:21 +05:30
lib ci(actions): set up automated deploys using github actions 2022-05-23 09:22:27 +05:30
native/ketbin_utils_syntax Tweak rust linker flags 2021-12-08 22:32:35 +05:30
priv chore: migrate to prod 2021-10-08 01:56:42 +05:30
rel/overlays/bin feat: set up deploys with fly 2022-05-06 19:54:58 +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
fly.toml feat: set up deploys with fly 2022-05-06 19:54:58 +05:30
Makefile chore(build): add image to push dependencies 2021-12-08 23:12:17 +05:30
mix.exs chore(config): upgrade deprecated config modules 2022-05-06 17:11:47 +05:30
mix.lock chore(config): upgrade deprecated config modules 2022-05-06 17:11:47 +05:30
README.md Fixed a typo 2021-12-08 22:31:29 +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

README.md

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