https://github.com/simplytil/yourls-shortener-extension
YOURLS Chrome Extension to add usability with YOURLS host
https://github.com/simplytil/yourls-shortener-extension
extension extension-chrome yourls yourls-extension
Last synced: about 1 month ago
JSON representation
YOURLS Chrome Extension to add usability with YOURLS host
- Host: GitHub
- URL: https://github.com/simplytil/yourls-shortener-extension
- Owner: SimplyTil
- License: gpl-3.0
- Created: 2025-03-04T20:17:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-19T20:06:49.000Z (over 1 year ago)
- Last Synced: 2025-03-19T21:26:12.967Z (about 1 year ago)
- Topics: extension, extension-chrome, yourls, yourls-extension
- Language: JavaScript
- Homepage: https://chromewebstore.google.com/detail/yourls-link-shortener/bpaidpglokfmipgcbippdmcncngcjghh
- Size: 67.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Chrome Extension for YOURLS Link Shortener
A modern browser extension for quickly shortening URLs with your own [YOURLS](https://yourls.org/) (Your Own URL Shortener) instance. Built with Manifest V3 compatibility for Chrome and Chromium-based browsers.
##  Features
### Core Functionality
- **One-click URL shortening** from any webpage
- **Custom keywords** for personalized short links
- **Auto-copy** shortened URLs to clipboard
- **Context menu integration** for quick access
- **Bulk operations** support
### Advanced Analytics
- **Comprehensive dashboard** with real-time statistics
- **Performance metrics** including clicks today, this week, and this month
- **Top performing links** with detailed click analytics
- **Server information** including YOURLS version and database statistics
- **Data export** functionality for further analysis
- **Visual charts** and animated counters for better data presentation
### Multi-Server Support
- **Primary and additional server** configurations
- **Server switching** in popup and analytics views
- **Independent analytics** for each server
- **Custom server naming** for easy identification
### Internationalization
- **14 languages** supported including RTL languages
- **Dynamic language switching** without restart
- **Localized error messages** and help text
- **RTL layout support** for Arabic and other RTL languages
### Advanced Settings
- **Auto-save settings** for seamless experience
- **Connection testing** for both servers
- **Customizable behavior** options
- **Modern tabbed interface** for organized settings
## 🚀 Installation
### Chrome Web Store (Recommended)
1. Visit the [Chrome Web Store page](https://lyxo.link/l4kzv)
2. Click "Add to Chrome"
3. Confirm the installation
### Manual Installation
1. Download the latest release from [GitHub Releases](https://github.com/simplytil/yourls-shortener-extension/releases)
2. Extract the zip file to a folder
3. In Chrome, go to `chrome://extensions/`
4. Enable "Developer mode" in the top-right corner
5. Click "Load unpacked" and select the extracted folder
## ⚙️ Configuration
### Setting Up Your YOURLS Server
1. Click the extension icon and select "Settings" (gear icon)
2. Navigate to the "Servers" tab
#### Primary Server Configuration
- **YOURLS Server URL**: Enter the base URL of your YOURLS installation
- Example: `https://your-domain.com/yourls` or `http://localhost/yourls`
- Make sure to include the correct protocol (`http://` or `https://`)
- You don't need to include `yourls-api.php` at the end
- **Signature Token**: Enter your YOURLS signature token
- Find this in your YOURLS admin panel under Tools → API
- Click "Test Connection" to verify your settings
#### Additional Server (Optional)
- Enable the "Additional YOURLS server" toggle
- Configure URL, signature token, and display name
- Use the server selector dropdown in the popup to switch between servers
### General Settings
Navigate to the "General" tab to configure behavior and interface options:
- **Always ask for keyword**: When enabled, you'll be prompted for a custom keyword each time
- **Auto-copy shortened URL**: Automatically copy the short URL to your clipboard
- **Auto-save settings**: Save changes automatically without clicking the save button
- **Language**: Choose your preferred language from the dropdown
## 📝 Usage
### Basic Usage
1. Navigate to any webpage you want to shorten
2. Click the YOURLS extension icon in your toolbar
3. (Optional) Enter a custom keyword if the setting is enabled
4. Click "Shorten URL"
5. Copy the shortened URL or use it directly (it's automatically copied if auto-copy is enabled)
### Context Menu
- Right-click on any link
- Select "Shorten Link" from the context menu
- The extension popup will open with that link ready to be shortened
### Dashboard
Click the extension icon, then open settings and go to the "Dashboard" tab to:
- View statistics from your YOURLS server
- See your most recently created short links
- Copy any of your recent links with a single click
- Switch between servers (if you've configured multiple)
## 🛠 Technical Details
- Built with Manifest V3 for modern browser compatibility
- Uses background scripts to handle API requests and bypass CORS restrictions
- Implements modern JavaScript with async/await patterns
- Utilizes CSS custom properties for consistent theming
- Provides comprehensive error handling and user feedback
## 🔍 Troubleshooting
### Common Issues
**Connection Failed**
- Verify your YOURLS URL is correct and includes the protocol (`http://` or `https://`)
- Check that your signature token is valid
- Ensure your YOURLS server is online and accessible
**Extension Not Working**
- Check browser console for any error messages
- Verify that you have the necessary permissions enabled
- Try reinstalling the extension
**Server Not Showing in Dashboard**
- Make sure you've properly configured server settings
- Check that your YOURLS API is properly responding
- Some older YOURLS versions may not support all dashboard features
## 📚 Resources
- [YOURLS Official Website](https://yourls.org/)
- [YOURLS Documentation](https://docs.yourls.org/)
- [Report Issues](https://github.com/simplytil/yourls-shortener-extension/issues)
## 📜 License
```
Copyright 2025 YOURLS Link Shortener Contributors
Licensed under the GNU General Public License v3.0 (GPL-3.0)
You may obtain a copy of the License at
https://www.gnu.org/licenses/gpl-3.0.html
```
## 👏 Acknowledgments
- Thanks to [binfalse](https://github.com/binfalse) for the initial idea and code foundation
- YOURLS team for creating the excellent URL shortener platform