mirror of https://github.com/YOURLS/YOURLS
104 lines
8.4 KiB
Markdown
104 lines
8.4 KiB
Markdown
<h1 align="center">
|
|
<a href="https://yourls.org">
|
|
<img src="images/yourls-logo.svg" width=66% alt="YOURLS">
|
|
</a>
|
|
</h1>
|
|
|
|
> Your Own URL Shortener
|
|
|
|
 [](https://scrutinizer-ci.com/g/YOURLS/YOURLS/?branch=master)  [](https://packagist.org/packages/yourls/yourls) [](https://opencollective.com/yourls#contributors)
|
|
[](#sponsors)
|
|
|
|
**YOURLS** is a set of PHP scripts that will allow you to run <strong>Y</strong>our <strong>O</strong>wn <strong>URL</strong> <strong>S</strong>hortener, on **your** server. You'll have full control over your data, detailed stats, analytics, plugins, and more. It's free and open-source.
|
|
|
|
## Quick Start
|
|
|
|
Get YOURLS :
|
|
* Download the latest [release](https://github.com/YOURLS/YOURLS/releases)
|
|
* Using Composer? You can simply `composer create-project yourls/yourls .` in an empty directory.
|
|
|
|
Install YOURLS:
|
|
* Read [yourls.org](https://yourls.org) for starters
|
|
* The complete documentation is on [docs.yourls.org](https://docs.yourls.org) and contains everything from beginners to experts.
|
|
|
|
## Community news, tips and tricks
|
|
|
|
* Read and subscribe to the [The Official YOURLS Blog](http://blog.yourls.org)
|
|
* Check what the user community makes: plugins, tools, guides and more on [Awesome YOURLS](https://github.com/YOURLS/awesome-yourls)
|
|
* Engage users and ask for help in our [community discussions](https://github.com/YOURLS/YOURLS/discussions)
|
|
* Keep track of development: "Star" and "Watch" this project, follow [commit messages](https://github.com/YOURLS/YOURLS/commits/master)
|
|
|
|
## Contributing
|
|
|
|
Feature suggestion? Bug to report?
|
|
|
|
__Before opening any issue, please search for existing [issues](https://github.com/YOURLS/YOURLS/issues) (open and closed) and read the [Contributing Guidelines](https://github.com/YOURLS/.github/blob/master/CONTRIBUTING.md).__
|
|
|
|
|
|
## Backers
|
|
|
|
Do you use and enjoy YOURLS? [Become a backer](https://opencollective.com/yourls#backer) and show your support to our open source project.
|
|
|
|
[](https://opencollective.com/yourls/backer/0/website)
|
|
[](https://opencollective.com/yourls/backer/1/website)
|
|
[](https://opencollective.com/yourls/backer/2/website)
|
|
[](https://opencollective.com/yourls/backer/3/website)
|
|
[](https://opencollective.com/yourls/backer/4/website)
|
|
[](https://opencollective.com/yourls/backer/5/website)
|
|
[](https://opencollective.com/yourls/backer/6/website)
|
|
[](https://opencollective.com/yourls/backer/7/website)
|
|
[](https://opencollective.com/yourls/backer/8/website)
|
|
[](https://opencollective.com/yourls/backer/9/website)
|
|
[](https://opencollective.com/yourls/backer/10/website)
|
|
[](https://opencollective.com/yourls/backer/11/website)
|
|
[](https://opencollective.com/yourls/backer/12/website)
|
|
[](https://opencollective.com/yourls/backer/13/website)
|
|
[](https://opencollective.com/yourls/backer/14/website)
|
|
[](https://opencollective.com/yourls/backer/15/website)
|
|
[](https://opencollective.com/yourls/backer/16/website)
|
|
[](https://opencollective.com/yourls/backer/17/website)
|
|
[](https://opencollective.com/yourls/backer/18/website)
|
|
[](https://opencollective.com/yourls/backer/19/website)
|
|
[](https://opencollective.com/yourls/backer/20/website)
|
|
[](https://opencollective.com/yourls/backer/21/website)
|
|
[](https://opencollective.com/yourls/backer/22/website)
|
|
[](https://opencollective.com/yourls/backer/23/website)
|
|
[](https://opencollective.com/yourls/backer/24/website)
|
|
[](https://opencollective.com/yourls/backer/25/website)
|
|
[](https://opencollective.com/yourls/backer/26/website)
|
|
[](https://opencollective.com/yourls/backer/27/website)
|
|
[](https://opencollective.com/yourls/backer/28/website)
|
|
[](https://opencollective.com/yourls/backer/29/website)
|
|
|
|
|
|
## Sponsors
|
|
|
|
Does your company use YOURLS? Ask your manager or marketing team if your company would be interested in supporting our project. Your company logo will show here. Help support our open-source development efforts by [becoming a sponsor](https://opencollective.com/yourls).
|
|
|
|
[](https://opencollective.com/yourls/sponsor/0/website)
|
|
[](https://opencollective.com/yourls/sponsor/1/website)
|
|
[](https://opencollective.com/yourls/sponsor/2/website)
|
|
[](https://opencollective.com/yourls/sponsor/3/website)
|
|
[](https://opencollective.com/yourls/sponsor/4/website)
|
|
[](https://opencollective.com/yourls/sponsor/5/website)
|
|
[](https://opencollective.com/yourls/sponsor/6/website)
|
|
[](https://opencollective.com/yourls/sponsor/7/website)
|
|
[](https://opencollective.com/yourls/sponsor/8/website)
|
|
[](https://opencollective.com/yourls/sponsor/9/website)
|
|
[](https://opencollective.com/yourls/sponsor/10/website)
|
|
[](https://opencollective.com/yourls/sponsor/11/website)
|
|
[](https://opencollective.com/yourls/sponsor/12/website)
|
|
[](https://opencollective.com/yourls/sponsor/13/website)
|
|
[](https://opencollective.com/yourls/sponsor/14/website)
|
|
[](https://opencollective.com/yourls/sponsor/15/website)
|
|
[](https://opencollective.com/yourls/sponsor/16/website)
|
|
[](https://opencollective.com/yourls/sponsor/17/website)
|
|
[](https://opencollective.com/yourls/sponsor/18/website)
|
|
[](https://opencollective.com/yourls/sponsor/19/website)
|
|
|
|
|
|
## License
|
|
|
|
Free software. Do whatever the hell you want with it.
|
|
YOURLS is released under the [MIT license](LICENSE).
|