You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Julia Luna be85e0d97a
add readme
3 months ago
leftists critical fix 3 months ago
lonk remove django_scopes 3 months ago
tests remove django_scopes 3 months ago
.gitignore initial commit 3 months ago
README.md add readme 3 months ago
manage.py initial commit 3 months ago
requirements-dev.txt add dev requirements 3 months ago
requirements.txt remove django_scopes 3 months ago

README.md

lonk

...is a simple, hackable link shortener with good enough performance

[python >= 3.8] [django >= 4.0]

How the fuck do I deploy this??

Development:

  • clone the repo
  • set up python environment
    • python3 -m venv env
      source env/bin/activate
      pip install -r requirements.txt
      
  • ./manage.py migrate
  • ./manage.py createsuperuser
  • ./manage.py runserver

Production:

  • clone the repo
  • take a look through the settings.py file
    • follow the official documentation
      • ALLOWED_HOSTS differs for this project. either:
        • set it to ["*"] and run behind a http reverse proxy that matches by host header
        • set it to a list of all domains that should be served.
      • I personally have had a good experience with running gunicorn behind nginx.
    • or at the very least, turn off debug mode and generate a proper secret (e.g. $ openssl rand -base64 64)

(speculative) FAQ

Q: performance? in a django project?
A: yes! it does 1400 requests per second on the redirect endpoints in a basic deployment1.

Q: my other domains aren't showing up? how do I tell lonk that they exist?
A: simply access lonk on those domains! it'll pick them up by http host headers2

Q: how do I remove domains?
A: currently, through the backend shell. Front end domain management will be added in a future release.


  1. gunicorn -w 2 lonk.wsgi:application, no proxy ↩︎

  2. specifically, it uses request.get_host(), see the documentation for details ↩︎