valentin
/
ltsNinja
mirror of https://github.com/itsmrval/ltsNinja
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Web interface to reduce long URLs to short extensions
14 Commits
1 Branch
2 Tags
10 MiB
HTML 58.4%
Go 41.6%
 
 
Go to file
itsmrval 5e2cdb20ba feat(footer) added footer 2024-08-02 14:55:10 +02:00
static/img feat(dashboard) frontend & working 2024-08-02 11:16:54 +02:00
templates feat(footer) added footer 2024-08-02 14:55:10 +02:00
.gitignore feat(dashboard) frontend & working 2024-08-02 11:16:54 +02:00
LICENSE Initial commit 2024-07-10 13:54:19 +02:00
README.md Update README.md 2024-08-02 14:47:33 +02:00
example.env feat(env) example env 2024-08-02 12:00:50 +02:00
go.mod fix(mod) renaming 2024-08-02 11:42:27 +02:00
go.sum mv(all) moving repository 2024-07-10 16:10:20 +02:00
index.go fix(static) serving assets on compilated build 2024-08-02 14:40:09 +02:00

README.md


Logo

ltsNinja

Simple and lightwell url shortener running GO.

Explore demo · Report Bug · Pull request

Table of contents
  1. What is ltsNinja ?
  2. Getting started
  3. Roadmap
  4. License

What is ltsNinja

Homepage Dashboard

ltsNinja is a public, self-hosted tool that makes it easy to shorten urls. It's very lightweight and intuitive, which means it runs with very little performance.

Few key points:

  • Github login for custom links
  • Easy dashboard for users

(back to top)

Built With

This section list major frameworks/libraries used

(back to top)

Getting Started

Now let's see how to set up an ltsNinja instance.

Installation

  1. Create directory

    mkdir /opt/ltsNinja
cd /opt/ltsNinja

  2. Download the latest release and apply permissions

    wget -O ltsNinja https://github.com/itsmrval/ltsNinja/releases/download/0.1.0/ltsNinja_linux_amd64
chmod +x ltsNinja

  3. Create the service on systemd Write the file

    nano /etc/systemd/system/ltsNinja.service

    Complete and put the service file below:

    [Unit]
Description=LTS Ninja service
After=network.target

[Service]
Type=simple
ExecStart=/opt/ltsNinja/ltsNinja
Environment="GITHUB_CLIENT_ID=<REPLACE HERE>"
Environment="GITHUB_CLIENT_SECRET=<REPLACE HERE>"
Environment="GITHUB_REDIRECT_URL=https://<REPLACE HERE>/callback"
Environment="DB_PATH=/opt/ltsNinja/database.db"
Environment="PORT=8080"

[Install]
WantedBy=multi-user.target

  4. Reload systemd and run the service !

    systemctl daemon-reload
systemctl enable --now ltsNinja

(back to top)

Roadmap

  • URL Shortener
  • Custom links
  • User dashboard
  • Edit with github
  • Admin dashboard

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)