links/README.md

URL Manager

A URL management tool that helps you organize and access your links efficiently.

Features

• Create and manage short links
• Template links with dynamic parameters
• Bookmark pages with automatic title and summary extraction
• Advanced search capabilities
• API access
• Asynchronous page processing

Installation

Using Docker (Recommended)

1. Prerequisites:

   • Docker
   • Docker Compose

2. Clone the repository:

   git clone https://github.com/yourusername/url-manager.git
   cd url-manager
   

3. Build and start services:

   ./manage-docker.sh build
   ./manage-docker.sh start
   

The application will be available at http://localhost:8000

Docker Management Commands

• Start all services:

  ./manage-docker.sh start
  

• Stop all services:

  ./manage-docker.sh stop
  

• Restart services:

  ./manage-docker.sh restart
  

• View logs:

  ./manage-docker.sh logs
  

• Run database migrations:

  ./manage-docker.sh migrate
  

• Create new migrations:

  ./manage-docker.sh makemigrations
  

• Access Django shell:

  ./manage-docker.sh shell
  

Docker Services

The application runs the following services:

• web: Django web server (port 8000)
• celery_worker: Processes background tasks
• celery_beat: Schedules periodic tasks
• redis: Message broker and result backend

Manual Installation

If you prefer not to use Docker:

1. Install Python 3.12 and Redis

2. Install dependencies:

   pip install -r requirements.txt
   

3. Run migrations:

   python manage.py migrate
   

4. Start the development server:

   ./run_server.sh
   

5. Start Celery worker:

   ./worker.sh
   

6. Start Celery beat:

   ./celery_beat.sh
   

Usage

Managing Links

1. Create a new link:

   • Visit /create/
   • Enter the original URL and desired alias
   • For template links, use {param} syntax

2. Access a link:

   • Use http://localhost:8000/your-alias
   • For template links: http://localhost:8000/your-alias/parameter

Managing Pages

1. Create a new page:

   • Visit /ui/pages/new/
   • Enter the URL
   • Title and summary will be automatically extracted

2. View all pages:

   • Visit /ui/pages/

API Access

The application provides a REST API:

• List pages: GET /api/pages/
• Create page: POST /api/pages/

Example:

Monitoring Celery Tasks

The application includes Flower for monitoring Celery tasks. You can access it in two ways:

1. Direct access:

   • Visit http://localhost:5555 in your browser

2. Using management script:

   ./manage-docker.sh flower
   

Flower provides:

• Real-time monitoring of Celery tasks
• Task progress and history
• Worker status and statistics
• Error tracking
• Task graphs and charts

Monitoring Features

1. View all tasks:

   • Active tasks
   • Scheduled tasks
   • Failed tasks
   • Success rate

2. Worker information:

   • Status
   • Resource usage
   • Queue length

3. Task details:

   • Arguments
   • Start time
   • Runtime
   • Result
   • Stack traces for failed tasks