mirror of
https://github.com/minoplhy/chhoto-url.git
synced 2024-11-22 17:26:45 +00:00
218f2fa368
* Migrated ur an sqlite database * Removed unnecessary IOExceptions * Removed an util class not needed anymore * Updated README.md and docker-compose.yml to reflect new storage mechanism * This change was not meant for this branch * Port change with environment variable * Unused imports * Updated README.md * Added basic protection against duplication
107 lines
3.5 KiB
Markdown
107 lines
3.5 KiB
Markdown
# What is it?
|
|
A simple selfhosted URL shortener with no name because naming is hard
|
|
|
|
## But why another URL shortener?
|
|
I've looked at a couple popular URL shorteners, however they either have
|
|
unnecessary features, or they didn't have all the features I wanted.
|
|
|
|
# Features
|
|
- Shortens URLs of any length to a fixed length, randomly generated string
|
|
- (Optional) Allows you to specify the shortened URL instead of the generated
|
|
one (Missing in a surprising number of alternatives)
|
|
- Opening the fixed length URL in your browser will instantly redirect you
|
|
to the correct long URL (you'd think that's a standard feature, but
|
|
apparently it's not)
|
|
- Provides a simple API for adding new short links
|
|
- Links are stored in an SQLite database
|
|
- Available as a Docker container (there is no image on docker hub _yet_)
|
|
- Backend written in Java using [Spark Java](http://sparkjava.com/), frontend
|
|
written in plain HTML and vanilla JS, using [Pure CSS](https://purecss.io/)
|
|
for styling
|
|
|
|
# Bloat that will not be implemented
|
|
- Logging, tracking or spying of any kind. The only logs that still exist are
|
|
errors printed to stderr and the default SLF4J warning
|
|
- User management. If you need a shortener for your whole organisation, either
|
|
run separate containers for everyone or use something else
|
|
- Cookies, newsletters, "we value your privacy" popups or any of the multiple
|
|
other ways modern web shows how anti-user it is. We all hate those and they're
|
|
not needed here
|
|
- Paywalls or messages beging for donations. If you want to support me (for
|
|
whatever reason), you can message me through Github issues or via email
|
|
[github@draganczuk.tk](mailto:github@draganczuk.tk)
|
|
|
|
I _might_ add one of those "fork me on github" thingies in the corner, though I
|
|
doubt I will
|
|
|
|
# Screenshot
|
|
|
|
|
|
# Planned features for 1.0 (in order of importance
|
|
- Better deduplication
|
|
- Code cleanup
|
|
- Official Docker Hub image
|
|
|
|
# Usage
|
|
Clone this repository
|
|
```
|
|
git clone https://github.com/draganczukp/simply-shorten
|
|
```
|
|
## Building from source
|
|
Gradle 6.x.x and JDK 11 are required. Other versions are not tested
|
|
### 1. Build the `.jar` file
|
|
```
|
|
gradle build --no-daemon
|
|
```
|
|
The `--no-daemon` option means that gradle should exit as soon as the build is
|
|
finished. Without it, gradle would still be running in the background
|
|
in order to speed up future builds.
|
|
|
|
### 2. Set environment variables
|
|
```bash
|
|
# Required for authentication
|
|
export username=<api username>
|
|
export password=<api password>
|
|
# Sets where the database exists. Can be local or remote (optional)
|
|
export db.url=<url> # Default: './urls.sqlite'
|
|
```
|
|
|
|
### 3. Run it
|
|
```
|
|
java -jar build/libs/url.jar
|
|
```
|
|
You can optionally set the port the server listens on by appending `--port=[port]`
|
|
|
|
### 4. Navigate to `http://localhost:4567` in your browser, add links as you wish.
|
|
|
|
## Running with docker
|
|
### `docker run` method
|
|
1. Build the image
|
|
```
|
|
docker build . -t shorten:latest
|
|
```
|
|
2. Run the image
|
|
```
|
|
docker run -p 4567:4567
|
|
-d url:latest
|
|
-e username="username"
|
|
-e password="password"
|
|
-d shorten:latest
|
|
```
|
|
2.a Make the database file available to host (optional)
|
|
```
|
|
touch ./urls.sqlite
|
|
docker run -p 4567:4567 \
|
|
-e username="username" \
|
|
-e password="password" \
|
|
-v ./urls.sqlite:/urls.sqlite \
|
|
-e db.url=/urls.sqlite \
|
|
-d shorten:latest
|
|
```
|
|
## `docker-compose`
|
|
There is a sample `docker-compose.yml` file in this repository configured for Traefik. You can use it
|
|
as a base, modifying it as needed. Run it with
|
|
```
|
|
docker-compose up -d --build
|
|
```
|