devshort

private self-hosted shortlink service
git clone git://git.clttr.info/devshort.git
Log (Feed) | Files | Refs (Tags) | README | LICENSE

README.md (2930B)


      1 # 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 
     19 ### modifications compared to original devShort
     20 * Short-URLs are case-insensitive, means "link" and "LINK" are the same redirect
     21 * Explore section: show a random shortlink on index page
     22 * fix for loosing counters
     23 
     24 ## 1-2-3 Reasons to install
     25 1. Give everyone a good-looking and easy to remember link
     26 2. Know when and how many times the links are used
     27 3. Have no hassle with the software because it's slim and easy to configure
     28 4. Absolutely no external deps, all that's required is shipped with the software.
     29 
     30 ## 1-2-3 Step installation
     31 1. Download the latest [release](https://src.clttr.info/rwa/devshort/releases) and upload it to the desired installation place
     32 2. Move `admin/config.json.example` to `admin/config.json` and `admin/stats.json.example` to `admin/stats.json`
     33 3. Adjust the configuration in `admin/config.json`, especially **insert a admin password**   
     34 The passwort will be securely hashed at the first login on the admin page.
     35 4. Start using devShort! 
     36 
     37 ### Requirements
     38 * Webserver (Apache, nginx, Caddy, ...)
     39 * PHP 7.4 or above
     40 
     41 ## 1-2-3 Step update
     42 1. Download the latest [release](https://src.clttr.info/rwa/devshort/releases) and upload it to the installation place
     43 2. Start using devShort!
     44 
     45 ## Configuration
     46 All configuration is done in the file `data/config.json`. Below is a list of values that should be adjusted by the instance admin.
     47 
     48 * `admin_password` -> password for the admin panel, is securely hashed after first login
     49 * `name` -> name of your site
     50 * `author` -> name of the author/admin
     51 * `author_link` -> link to your profile on a social network, keybase or similar, uses the "rel=me" flag
     52 * `home_link` -> link to your homepage
     53 * `favicon` -> relative path to your favicon, e.g. `assets/icon.png`
     54 * `random_shortlink` -> show "explore" section on index page, `true` or `false`
     55 * `custom_links` -> arbitrary amount of custom links that are shown on the right side of the footer
     56 
     57 ## About
     58 * Maintainer: [René Wagner](https://src.clttr.info/rwa)
     59 * Creator: [flokX](https://github.com/flokX)
     60 
     61 License: [The MIT License](https://git.sr.ht/~rwa/devshort/tree/master/LICENSE)
     62 
     63 Third-party credits:
     64 * [Vue.js](https://vuejs.org/)
     65 * [Bootstrap](https://getbootstrap.com)
     66 * [Frappe Charts](https://github.com/frappe/charts)
     67 * [IO-Images](https://pixabay.com/users/io-images-1096650)