Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/easypanel-community/easyshortener
A simple URL shortener created with Laravel 10
https://github.com/easypanel-community/easyshortener
laravel php
Last synced: 2 months ago
JSON representation
A simple URL shortener created with Laravel 10
- Host: GitHub
- URL: https://github.com/easypanel-community/easyshortener
- Owner: Easypanel-Community
- License: mit
- Created: 2023-02-02T02:16:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-20T03:23:53.000Z (4 months ago)
- Last Synced: 2024-02-20T04:28:47.414Z (4 months ago)
- Topics: laravel, php
- Language: PHP
- Homepage:
- Size: 569 KB
- Stars: 77
- Watchers: 1
- Forks: 13
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-selfhosted - Easyshortener - A simple URL shortener. `MIT` `PHP/Nodejs/Docker` (Software / URL Shorteners)
- awesome-selfhosted - Easyshortener - A simple URL shortener. `MIT` `PHP/Nodejs/Docker` (Software / URL Shorteners)
- fucking-awesome-selfhosted - Easyshortener - A simple URL shortener. `MIT` `PHP/Nodejs/Docker` (Software / URL Shorteners)
- awesome-selfhosted - Easyshortener - A simple URL shortener. `MIT` `PHP/Nodejs/Docker` (Software / URL Shorteners)
README
## :busts_in_silhouette: Multi user
Easyshortener can have multiple users \
Manage all of them from the built-in administration panel
## :lock: Two Factor Authentication
Have piece of mind with built in two factor authentication
## :sparkles: Easy to use
Crafted with love and care to provide the best experience possible
## :whale2: Built for docker
Deploy Easyshortener easier with your favorite container engine
---
[](https://gitpod.io#snapshot/bef448f4-541b-41b5-a5a7-daa545f26171)
[](https://easypanel.io/docs/templates/easyshortener)
## Installation
Confused? Check out our [install guide](https://github.com/Easypanel-Community/easyshortener/blob/main/INSTALL.md)
- `composer install` - Installs dependencies to last updated version
- `php artisan migrate` - Migrates the database
- Set `EASYSHORTENER_ALLOW_REGISTRATION` to `true` to create your account - run `php artisan config:cache` once done
- `npm run build` - Builds assets
## Docker
[Compose file](https://github.com/Easypanel-Community/easyshortener/blob/main/docker/docker-compose.yml)
```
docker run --name easyshortener -v /etc/easyshortener:/var/www/html -e APP_DEBUG=false -e EASYSHORTENER_ENABLE_REGISTRATION=true -e EASYSHORTENER_INSTALLATION_ENV=docker -e EASYSHORTENER_ALLOW_ANALYTICS=true -e FORCE_HTTPS=false -e DB_CONNECTION=sqlite -e DB_DATABASE=/database/sqlite/easyshortener.db ghcr.io/easypanel-community/easyshortener
```
Need to access your container? Use `docker exec -it imageid /bin/sh`
## Testing
- `php artisan test` - Running this will refresh the entire database
- `php artisan db:seed` - This creates a user called `User` with the credentials `[email protected]:password`
## Commands
| Command | Description | Arguments |
| ----------------------- | -------------- | --------- |
| php artisan view:link | View all the links currently available on your Easyshortener instances connected database | None |
| php artisan delete:link | Delete a link from your Easyshortener instance | ID |
## Environment Variables
| Variable | Description | Arguments |
| -------------------------------- | ------------------ | ------------------------ |
| EASYSHORTENER_ALLOW_REGISTRATION | Allows registration for your Easyshortener instance | true/false |
| EASYSHORTENER_INSTALLATION_ENV | Sets the install platform of your Easyshortener instance | easypanel/docker/webhost |
| EASYSHORTENER_ALLOW_ANALYTICS | Disable redirect tracking for all links on your Easyshortener instance | true/false |
| FORCE_HTTPS | Force HTTPS connection for your Easyshortener instance | true/false |
## License
Easyshortener is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).