How to Install and Run Teedy: Your Lightweight Document Management System

Mar 20, 2024 | Programming

Are you looking for an efficient way to manage documents—whether for personal use or for your business? Look no further than Teedy, an open-source, lightweight document management system. In this article, we will guide you through the installation process and explore Teedy’s powerful features.

Getting Started with Teedy

Teedy comes equipped with a wide array of features aimed at improving your document management experience. From optical character recognition to flexible search capabilities, it’s designed to cater to your needs. Ready to dive in? Let’s get started with installation using Docker!

Installing Teedy with Docker

To run Teedy using Docker, follow the steps below:

  • Ensure that you have Docker installed on your system.
  • Use the preconfigured Docker image that includes OCR and media conversion tools. It’s designed to listen on port 8080.
  • For production purposes, it’s highly recommended to use PostgreSQL for the database instead of the embedded H2 database.

A Basic Docker Compose File Example

Below is an example of a Docker Compose file setup:

version: '3'
services:
  teedy-server:
    image: sismicsdocs:v1.11
    restart: unless-stopped
    ports:
      - 8080:8080
    environment:
      DOCS_BASE_URL: https://docs.example.com
      DOCS_ADMIN_EMAIL_INIT: admin@example.com
      DOCS_ADMIN_PASSWORD_INIT: $$2a$$05$$PcMNUbJvsk7QHFSfEIDaIOjk1VI9E7IPjTKx.jkjPxkx2EOKSoPS
      DATABASE_URL: jdbc:postgresql:teedy-db:5432/teedy
      DATABASE_USER: teedy_db_user
      DATABASE_PASSWORD: teedy_db_password
      DATABASE_POOL_SIZE: 10
    volumes:
      - .docsdata:data
    networks:
      - docker-internal
      - internet
    depends_on:
      - teedy-db
  teedy-db:
    image: postgres:13.1-alpine
    restart: unless-stopped
    expose:
      - 5432
    environment:
      POSTGRES_USER: teedy_db_user
      POSTGRES_PASSWORD: teedy_db_password
      POSTGRES_DB: teedy
    volumes:
      - .docsdb:/var/lib/postgresql/data
    networks:
      - docker-internal
networks:
  docker-internal:
    driver: bridge
  internet:
    driver: bridge

In this analogy, think of the Docker container as a virtual storage box. It keeps everything you need—Teedy, your database, and even the documents secure and in one place—similar to how you would organize your files in a physical filing cabinet.

Set Up Environment Variables

Environment variables are crucial for the smooth functioning of Teedy. Some key variables include:

  • DOCS_BASE_URL: The base URL used by the application.
  • DOCS_ADMIN_EMAIL_INIT: The admin’s email during initialization.
  • DOCS_ADMIN_PASSWORD_INIT: The hashed password for the admin.
  • DATABASE_URL: The connection string for the PostgreSQL database.

Troubleshooting Tips

Encountering issues while setting up Teedy? Here are a few troubleshooting tips:

  • If you experience access issues, check that you’ve exposed the necessary ports in Docker.
  • Ensure that your PostgreSQL database is running and that the connection details in your environment variables are correct.
  • When using the embedded H2 database for testing, remember that this should not be used for production.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

Enhance Your Experience with Teedy

The features of Teedy span a range from responsive UIs to robust security measures like two-factor authentication. You can also take advantage of functionalities such as:

  • Optical character recognition
  • File versioning
  • Document sharing via URL
  • RESTful Web API and webhooks

Conclusion

In conclusion, Teedy offers a powerful yet user-friendly solution for document management. With its wide range of features and flexible installation options, it’s a valuable tool for individuals and businesses alike.

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.

Stay Informed with the Newest F(x) Insights and Blogs

Tech News and Blog Highlights, Straight to Your Inbox