README.md (2957B)
1 # [devShort](https://sr.ht/~rwa/devshort) 2 3 The devShort URL shortener is the perfect choice for web developers, admins and professionals. It is simple and privacy friendly but very powerful since it focuses on the most important things. 4 5 **Jump to our [demo](https://clttr.info)!** 6 7 ## 1-2-3 Main features 8 1. Slim but powerful 9 * No database required 10 * Fast installation 11 * Integrated statistics viewer 12 * No feature overhead 13 2. Widely configurable for your needs with only one file 14 3. Privacy friendly 15 * Only the access count and date is tracked 16 * The whole code is verifiable in minutes 17 * Privacy and security by default 18 * No external dependencies 19 20 ### modifications compared to original devShort 21 * Short-URLs are case-insensitive, means "link" and "LINK" are the same redirect 22 * Explore section: show a random shortlink on index page 23 * fix for loosing counters 24 25 ## 1-2-3 Reasons to install 26 1. Give everyone a good-looking and easy to remember link 27 2. Know when and how many times the links are used 28 3. Have no hassle with the software because it's slim and easy to configure 29 4. Absolutely no external deps, all that's required is shipped with the software. 30 31 ## 1-2-3 Step installation 32 1. Download the latest [release](https://git.sr.ht/~rwa/devshort/refs) and upload it to the desired installation place 33 2. Move `data/config.json.example` to `data/config.json` and `data/stats.json.example` to `data/stats.json` 34 3. Adjust the configuration in `data/config.json`, especially **insert a admin password** 35 The passwort will be securely hashed at the first login on the admin page. 36 4. Start using devShort! 37 38 ### Requirements 39 * Webserver (Apache, nginx, Caddy, ...) 40 * PHP 8.0 or above 41 42 ## 1-2-3 Step update 43 1. Download the latest [release](https://git.sr.ht/~rwa/devshort/refs) and upload it to the installation place 44 2. Start using devShort! 45 46 ## Configuration 47 All configuration is done in the file `data/config.json`. Below is a list of values that should be adjusted by the instance admin. 48 49 * `admin_password` -> password for the admin panel, is securely hashed after first login 50 * `name` -> name of your site 51 * `author` -> name of the author/admin 52 * `author_link` -> link to your profile on a social network, keybase or similar, uses the "rel=me" flag 53 * `home_link` -> link to your homepage 54 * `favicon` -> relative path to your favicon, e.g. `assets/icon.png` 55 * `random_shortlink` -> show "explore" section on index page, `true` or `false` 56 * `custom_links` -> arbitrary amount of custom links that are shown on the right side of the footer 57 58 ## About 59 * Maintainer: [René Wagner](https://sr.ht/~rwa) 60 * Creator: [flokX](https://github.com/flokX) 61 62 License: [The MIT License](https://git.sr.ht/~rwa/devshort/tree/master/LICENSE) 63 64 Third-party credits: 65 * [Vue.js](https://vuejs.org/) 66 * [Bootstrap](https://getbootstrap.com) 67 * [Frappe Charts](https://github.com/frappe/charts) 68 * [IO-Images](https://pixabay.com/users/io-images-1096650)