Repository files navigation

URL ShortenerAPI Service

self-hostable open-source URL shortening web API service with a Fast API. It allows you to host your own URL shorten easy to use.

Urless is written in Python, using Redis as its primary database.( TODO redisgears + mysql)

Download the latest version of URLess via this image 'alivx/urless'.

docker-compose build#To build projectdocker-compose up#To run project, You can use `-d` option to run it in the background.

To test service run CURL command:

curl --location --request POST'http://127.0.0.1:8000/' \--header'Content-Type: application/json' \--data-raw'{"url":"www.google.com"}'

ORfrom browser openlocalhost and start testing the system.

To Deal with config for each app, you have two method.

1. settings.yaml
2. enviromnet varables. (This will override settings.yaml value)

In point 2, just useDYNACONF_[valueName], for example, in our API there is a config calledexposePort, to override it use this valueDYNACONF_exposePort. such asexport DYNACONF_exposePort=1991

If you want to use a custom config under docker-compose, just add it underenvironment section as explained above.

You can change value for each service config under filesettings.yaml

For nginx, you must change the config file underinfrastructure/nginx/urless.conf if you changesfrontend container name or port.

You can check the API documntion by/docs