yourls_ynh/README.md

<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->

# Yourls for YunoHost

[![Integration level](https://dash.yunohost.org/integration/yourls.svg)](https://dash.yunohost.org/appci/app/yourls) ![](https://ci-apps.yunohost.org/ci/badges/yourls.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/yourls.maintain.svg)  
[![Install Yourls with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=yourls)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install Yourls quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*

## Overview

YOURLS stands for Your Own URL Shortener. It is a small set of PHP scripts that will allow you to run your own URL shortening service (a la TinyURL or bitly).

### YOURLS Features

- Free and open-source software,
- Private (your links only) or Public (everybody can create short links, fine for an intranet),
- Terrific Plugin architecture and dozens of plugins to easily implement new features,
- Handy bookmarklets to easily shorten and share links,
- Awesome stats: historical click reports, referrers tracking, visitors geo-location,
- Developer API to integrate YOURLS into other applications,
- Sample files to create your own public interface and more !


**Shipped version:** 1.8.2~ynh1

**Demo:** https://yourls.org/cookie+

## Screenshots

![](./doc/screenshots/p4.png)

## Documentation and resources

* Official app website: https://yourls.org/
* Official admin documentation: https://github.com/YOURLS/YOURLS/wiki
* Upstream app code repository: https://github.com/YOURLS/YOURLS
* YunoHost documentation for this app: https://yunohost.org/app_yourls
* Report a bug: https://github.com/YunoHost-Apps/yourls_ynh/issues

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/yourls_ynh/tree/testing).

To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/yourls_ynh/tree/testing --debug
or
sudo yunohost app upgrade yourls -u https://github.com/YunoHost-Apps/yourls_ynh/tree/testing --debug
```

**More info regarding app packaging:** https://yunohost.org/packaging_apps
Auto-update README 2022-02-26 20:24:34 +01:00			`<!--`
			`N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator`
			`It shall NOT be edited by hand.`
			`-->`

			`# Yourls for YunoHost`
Update README.md 2020-03-29 13:36:46 +02:00
fix 2020-09-25 10:59:45 +02:00			`[![Integration level](https://dash.yunohost.org/integration/yourls.svg)](https://dash.yunohost.org/appci/app/yourls) ![](https://ci-apps.yunohost.org/ci/badges/yourls.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/yourls.maintain.svg)`
Auto-update README 2022-02-26 20:24:34 +01:00			`[![Install Yourls with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=yourls)`
Added readme 2017-07-16 23:57:43 +02:00
fix 2020-09-25 10:59:45 +02:00			`[Lire ce readme en français.](./README_fr.md)`

Auto-update README 2022-02-26 20:24:34 +01:00			`> *This package allows you to install Yourls quickly and simply on a YunoHost server.`
fix 2020-09-25 10:59:45 +02:00			`If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*`

			`## Overview`

Auto-update README 2022-02-26 20:24:34 +01:00			`YOURLS stands for Your Own URL Shortener. It is a small set of PHP scripts that will allow you to run your own URL shortening service (a la TinyURL or bitly).`
fix 2020-09-25 10:59:45 +02:00
Auto-update README 2022-02-26 21:24:31 +01:00			`### YOURLS Features`

			`- Free and open-source software,`
			`- Private (your links only) or Public (everybody can create short links, fine for an intranet),`
			`- Terrific Plugin architecture and dozens of plugins to easily implement new features,`
			`- Handy bookmarklets to easily shorten and share links,`
			`- Awesome stats: historical click reports, referrers tracking, visitors geo-location,`
			`- Developer API to integrate YOURLS into other applications,`
			`- Sample files to create your own public interface and more !`


Auto-update README 2022-02-26 20:24:34 +01:00			`Shipped version: 1.8.2~ynh1`
fix 2020-09-25 10:59:45 +02:00
Auto-update README 2022-02-26 20:24:34 +01:00			`Demo: https://yourls.org/cookie+`
fix 2020-09-25 10:59:45 +02:00
Auto-update README 2022-02-26 21:01:17 +01:00			`## Screenshots`

			`![](./doc/screenshots/p4.png)`

Auto-update README 2022-02-26 20:24:34 +01:00			`## Documentation and resources`
fix 2020-09-25 10:59:45 +02:00
Auto-update README 2022-02-26 20:24:34 +01:00			`* Official app website: https://yourls.org/`
Auto-update README 2022-02-27 08:34:41 +01:00			`* Official admin documentation: https://github.com/YOURLS/YOURLS/wiki`
Auto-update README 2022-02-26 21:01:17 +01:00			`* Upstream app code repository: https://github.com/YOURLS/YOURLS`
Auto-update README 2022-02-26 20:24:34 +01:00			`* YunoHost documentation for this app: https://yunohost.org/app_yourls`
			`* Report a bug: https://github.com/YunoHost-Apps/yourls_ynh/issues`
fix 2020-09-25 10:59:45 +02:00
			`## Developer info`

			`Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/yourls_ynh/tree/testing).`

			`To try the testing branch, please proceed like that.`
			```
			`sudo yunohost app install https://github.com/YunoHost-Apps/yourls_ynh/tree/testing --debug`
			`or`
			`sudo yunohost app upgrade yourls -u https://github.com/YunoHost-Apps/yourls_ynh/tree/testing --debug`
			```
Auto-update README 2022-02-26 20:24:34 +01:00
			`More info regarding app packaging: https://yunohost.org/packaging_apps`