Commit Graph

61 Commits

Author SHA1 Message Date
Yury Kossakovsky
c6ddcb061b Add comprehensive README.md for n8n Installer
- Introduced a detailed README.md to provide an overview of the n8n Installer, including its purpose, included services, installation instructions, and usage guidelines.
- Highlighted key features such as the ability to automate tasks, build AI applications, and access a rich toolset.
- Included information on community workflows, prerequisites for installation, and troubleshooting tips to enhance user experience.
2025-08-28 17:10:35 -06:00
Yury Kossakovsky
20dc71c307 Remove README.md as it is no longer needed for the project. This deletion streamlines the repository and eliminates outdated documentation. 2025-08-28 17:09:59 -06:00
Yury Kossakovsky
07b76b01a6 Update README.md to include n8n service details and improve organization
- Added n8n service description to the list of available tools, highlighting its low-code capabilities and integrations.
- Removed duplicate n8n entry from the access URLs section for clarity and consistency.
2025-08-28 14:36:03 -06:00
Yury Kossakovsky
e833f3e6d6 Update README.md to enhance service descriptions and organization
- Reorganized and clarified the list of included services, ensuring consistent formatting and improved readability.
- Added new services such as ComfyUI, Crawl4ai, Grafana, and others while removing outdated entries.
- Updated access URLs for various services to reflect recent changes in the installation process.
2025-08-28 14:31:05 -06:00
Yury Kossakovsky
220f008b31 Add Postgresus service configuration and credentials
- Introduced Postgresus service in docker-compose.yml with necessary environment variables and volume configuration.
- Updated .env.example to include Postgresus credentials (username, password, password hash).
- Modified Caddyfile to implement basic authentication for Postgresus.
- Enhanced scripts for secret generation to include Postgresus credentials.
- Updated README.md to add a description for Postgresus and its functionalities.
- Enhanced final report script to display Postgresus connection details if the service is active.
2025-08-28 11:00:12 -06:00
Yury Kossakovsky
c4d08b729b Add PaddleOCR configuration and credentials to environment and Caddyfile
- Updated .env.example to include PaddleOCR credentials (username, password, password hash).
- Modified Caddyfile to implement basic authentication for PaddleOCR using the new credentials.
- Enhanced docker-compose.yml to pass PaddleOCR environment variables to the service.
- Updated scripts to generate and manage PaddleOCR password securely.
- Added PaddleOCR documentation link in README.md for user reference.
2025-08-27 15:11:20 -06:00
Yury Kossakovsky
1a0bb409ac Update Cloudflare Tunnel instructions and README for clarity
- Changed installation command to use 'sudo bash' for better permissions handling.
- Clarified that the Cloudflare Tunnel service must be enabled in the Service Selection Wizard.
- Updated README to provide a direct link to the Cloudflare instructions.
2025-08-21 20:01:01 -06:00
Yury Kossakovsky
b2d4b1a0c6 Merge branch 'main' into main 2025-08-21 16:23:43 -06:00
Yury Kossakovsky
25ebc661b8 Add Postiz service integration and configuration
- Introduced Postiz as a new service in docker-compose.yml, including necessary environment variables and volume configurations.
- Updated Caddyfile to set up reverse proxy for Postiz.
- Enhanced README.md to document Postiz and its hostname for user reference.
- Modified scripts to include Postiz in the service selection wizard and final report for improved user guidance.
2025-08-19 13:54:50 -06:00
Yury Kossakovsky
512f919423 Add troubleshooting section to README.md for site loading issues
- Introduced a new section addressing common issues related to sites not loading after installation.
- Provided potential causes and solutions, including resource checks and minimal configuration testing to enhance user support and guidance.
2025-08-18 17:41:07 -06:00
Yury Kossakovsky
7037b203bb Add Python Runner service and documentation
- Introduced a new internal utility service, python-runner, in docker-compose.yml to execute custom Python scripts within the Docker network.
- Added detailed documentation in n8n-installer-developer-guide.md and README.md on how to enable and use the python-runner service.
- Created main.py and requirements.txt files for user-defined Python code and dependencies.
- Updated scripts to include python-runner in the service selection wizard and final report for improved user guidance.
2025-08-15 16:35:13 -06:00
Yury Kossakovsky
7062697b96 Add RAGApp documentation and internal access details
- Updated README.md to include RAGApp as a new open-source tool for building Retrieval-Augmented Generation assistants.
- Enhanced final report script to display internal access information for RAGApp, improving user visibility and integration guidance.
2025-08-15 12:58:43 -06:00
Adam
475f267d64 Adding cloudflare instructions + editing readme to remove them 2025-08-14 17:46:16 -04:00
TUCU-Adam
0ac3f89e15 Adding cloudflare tunnel mod
docker-compose.yml - Add the cloudflared service definition
.env.example - Add CLOUDFLARE_TUNNEL_TOKEN variable with documentation
scripts/03_generate_secrets.sh - Add tunnel token prompt with auto-enable logic
scripts/04_wizard.sh - Add cloudflare-tunnel to service selection menu
scripts/06_final_report.sh - Add security reminder when tunnel is enabled
README.md - Add comprehensive documentation section
2025-08-13 20:27:02 -04:00
Yury Kossakovsky
51d46d9144 Add ComfyUI as an optional service in the installer
- Updated .env.example to include COMFYUI_HOSTNAME for configuration.
- Modified Caddyfile to add a reverse proxy for ComfyUI at the specified hostname.
- Enhanced docker-compose.yml to include a new ComfyUI service with persistent storage and health checks.
- Updated scripts to integrate ComfyUI into the setup wizard and final report.
- Documented the integration process and reflections in the memory bank for future reference.
2025-08-07 22:13:01 -06:00
Yury Kossakovsky
a2d298fca5 Add Portainer documentation to README
- Included a description of Portainer as a lightweight web UI for managing Docker environments.
- Added Portainer access information to the services list in the README, specifying the URL and authentication details.
2025-08-07 21:40:52 -06:00
Yury Kossakovsky
ea253f4cc5 Add Dify AI Platform integration to n8n-installer project
- Integrated Dify, an open-source AI application development platform, as an optional service in the n8n-installer project.
- Updated start_services.py to include functions for cloning the Dify repository, preparing the environment, and starting Dify services.
- Configured docker-compose.yml to reference Dify's external Docker Compose file and included necessary environment variables.
- Enhanced Caddyfile with reverse proxy settings for Dify, ensuring proper routing and access.
- Updated .env.example to include Dify-specific configuration variables.
- Revised README.md to document Dify's capabilities and access details.
- Enhanced service selection wizard to allow users to choose Dify during setup.
- Comprehensive testing and validation phase pending to ensure full functionality.
2025-08-06 18:01:05 -06:00
Yury Kossakovsky
58b5f3383f Remove Gotenberg external access and update documentation for internal use only
- Removed Gotenberg configuration from .env.example and docker-compose.yml to restrict external access.
- Updated Caddyfile to eliminate reverse proxy settings for Gotenberg.
- Revised README.md to clarify that Gotenberg is now accessible only within the Docker network.
- Enhanced final report script to include internal access details and API documentation for Gotenberg.
2025-08-06 17:31:36 -06:00
Yury Kossakovsky
1fe9cf9e85 Add Gotenberg service integration to n8n-installer project
- Integrated Gotenberg, a document conversion API, as an optional service in the n8n-installer project.
- Updated docker-compose.yml to include Gotenberg service configuration with health checks and environment variables.
- Configured Caddy reverse proxy for Gotenberg, ensuring proper routing and SSL support.
- Enhanced service selection wizard to allow users to choose Gotenberg during setup.
- Updated .env.example and README.md to reflect the new service, including usage examples and access details.
- Comprehensive testing and validation phase pending to ensure full functionality.
2025-08-06 17:24:57 -06:00
Yury Kossakovsky
4863f44c6e Add Docker cleanup script and update README
- Introduced a new script, docker_cleanup.sh, for cleaning up unused Docker containers, images, and volumes to free up disk space.
- Updated README.md to include instructions for using the Docker cleanup script, emphasizing its utility and caution regarding data removal.
2025-08-06 10:41:09 -06:00
Yury Kossakovsky
3c4abffe1e Enhance README.md for Quick Start and Usage instructions
- Updated the Quick Start section to provide clearer access instructions for services post-installation, including login details for n8n and Flowise.
- Added steps for exploring n8n, utilizing integrated AI tools, and checking monitoring options with Grafana.
- Improved overall structure and clarity to facilitate user onboarding and understanding of available services.
2025-05-28 19:04:25 -06:00
Yury Kossakovsky
36a1b7ac1b Add contributors section to README.md
- Introduced a new section in README.md to acknowledge project contributors.
- Added a link to the GitHub Contributors Page for easy access to contributor information.
2025-05-28 16:37:12 -06:00
Yury Kossakovsky
ec4b0412a2 Add documentation for pre-installed libraries in n8n's Custom JavaScript
- Introduced a new section in README.md detailing the pre-installed Node.js libraries available for use in n8n's Code nodes, including `cheerio`, `axios`, `moment`, and `lodash`.
- Enhanced user understanding of available tools for web scraping, API requests, date manipulation, and utility functions.
2025-05-27 14:59:27 -06:00
Yury Kossakovsky
50e6725b2e Add Neo4j service configuration and update related files
- Introduced Neo4j service in docker-compose.yml with necessary environment variables and volume mappings.
- Updated Caddyfile to include reverse proxy settings for Neo4j.
- Enhanced .env.example to include placeholders for Neo4j username and password.
- Modified README.md to document Neo4j integration and access details.
- Added .cursorignore file to specify files and directories to ignore during indexing.
2025-05-27 14:23:01 -06:00
Cole Medin
bfcb95af45 Added Neo4j (Knowledge Graph Engine) to the Local AI Package 2025-05-26 13:04:41 -05:00
Yury Kossakovsky
c343d2c1e9 Add Weaviate service configuration and update documentation
- Introduced Weaviate service in docker-compose.yml with necessary environment variables and health checks.
- Updated Caddyfile to include reverse proxy settings for Weaviate with basic authentication.
- Enhanced README.md to document Weaviate's integration and access details.
- Modified scripts to generate secrets for Weaviate, including username and password handling.
- Updated final report script to display Weaviate configuration details for user clarity.
2025-05-24 09:41:14 -06:00
Yury Kossakovsky
d2abd6e036 Add Ollama service configuration to docker-compose.yml and update related files
- Introduced Ollama service with CPU and GPU profiles in docker-compose.yml, allowing users to run large language models locally.
- Added Ollama selection option in the wizard script for hardware profile configuration.
- Updated README.md to include Ollama as a new available service.
- Adjusted .env.example to include GRAFANA_HOSTNAME in the correct position.
2025-05-15 20:44:36 -06:00
Yury Kossakovsky
c3076a9990 Add Letta service configuration and update documentation
- Added Letta service to docker-compose.yml with necessary environment variables and volume configuration.
- Updated Caddyfile to include reverse proxy for Letta.
- Included Letta in the README.md for service availability and provided a brief description.
- Enhanced scripts to generate Letta server password and report its status in the final report.
- Updated .env.example to include Letta hostname and server password variable.
2025-05-15 19:11:33 -06:00
Yury Kossakovsky
5658594dd9 Add temporary "Dangerous Site" warning section to README.md
- Introduced a new section addressing potential browser security warnings after deploying services, detailing symptoms, causes, and solutions.
- This addition aims to assist users in troubleshooting common SSL certificate issues during initial service access.
2025-05-13 17:37:16 -06:00
Yury Kossakovsky
7a883959e4 Update README.md to require sudo for installation and update scripts
- Modified the installation and update commands in the README to include 'sudo', ensuring proper permissions for script execution.
- This change enhances the installation process by preventing potential permission issues during setup and updates.
2025-05-13 17:30:05 -06:00
Yury Kossakovsky
2a0721a6e4 Update README.md to reorganize automation categories
- Rearranged and updated the list of automation categories for clarity, ensuring that users can easily identify available workflows across various domains such as HR, E-commerce, and communication platforms.
2025-05-12 10:30:27 -06:00
Yury Kossakovsky
c60ee5ac94 Update README.md to include detailed community workflows section
- Added a new section outlining over 300 pre-built automations available for users, categorized by use cases such as AI agents, email handling, social media, and more, enhancing user onboarding and resource accessibility.
2025-05-12 10:29:53 -06:00
Yury Kossakovsky
000a1ae472 Add server requirements note to README.md
- Included a new point under the General Issues section to remind users to verify that their server meets the minimum hardware and operating system requirements, enhancing troubleshooting guidance.
2025-05-11 17:16:14 -06:00
Yury Kossakovsky
e26c05fc19 Add general issues section to README.md
- Introduced a new section addressing potential VPN conflicts that may interfere with downloading Docker images, providing users with troubleshooting guidance.
2025-05-11 16:26:22 -06:00
Yury Kossakovsky
481b145c32 Update README.md to enhance installation instructions and clarify server requirements
- Expanded the description of the installer, highlighting the rich toolset and scalable n8n performance.
- Revised DNS configuration instructions for clarity and updated server requirements to include specific memory, CPU, and disk space recommendations.
- Clarified the installation command and added details about the number of n8n workers during setup.
2025-05-09 18:54:33 -06:00
Yury Kossakovsky
f6d022b8a3 Update README.md to refine server requirements and clarify service configurations
- Revised minimum server system requirements to specify Ubuntu 24.04 LTS and 60 GB Disk Space.
- Added detailed memory and CPU recommendations for different service setups, enhancing user guidance for optimal performance.
2025-05-09 17:00:24 -06:00
Yury Kossakovsky
79d3078892 Update README.md to clarify service offerings and installation process
- Added details about core services (Caddy, Postgres, Redis) included in the installer.
- Revised the description of the service selection wizard to highlight available options during setup.
- Clarified the optional import of 300+ n8n community workflows for improved user understanding.
2025-05-09 16:04:42 -06:00
Yury Kossakovsky
26fedd1faa Update README.md for improved clarity and organization
- Revised project description to emphasize the self-hosted nature of the n8n Installer and its bundled tools.
- Enhanced the "What's Included" section to better outline the features and benefits of the setup.
- Streamlined installation instructions and clarified DNS configuration steps for user-friendliness.
- Updated troubleshooting tips for Supabase issues to provide clearer guidance.
- Improved formatting and consistency throughout the document for better readability.
2025-05-08 18:58:25 -06:00
Yury Kossakovsky
4d6ffb81c9 Refactor README.md to improve clarity and update terminology
- Changed the project name from "n8n Ecosystem Installer" to "n8n Installer" for consistency.
- Enhanced descriptions of included features, specifically renaming the optional workflow import to "300 n8n Community Workflows Included."
- Streamlined installation instructions and removed outdated notes to focus on essential information.
- Clarified the functionality of the installation script regarding service management.
2025-05-08 18:53:07 -06:00
Yury Kossakovsky
579681bfdd Update README.md to enhance clarity and include optional workflow import feature
- Streamlined the description of the n8n Ecosystem Installer, emphasizing its purpose and included tools.
- Added a note about the optional import of approximately 300 community workflows during setup.
- Reorganized the Important Links section for better accessibility and clarity.
2025-05-08 18:36:26 -06:00
Yury Kossakovsky
8dadb0bc37 Update server system requirements in README.md for accuracy
- Revised minimum server specifications to reflect a 60 GB disk requirement instead of 120 GB, ensuring clarity for users setting up the environment.
2025-05-08 16:29:47 -06:00
Yury Kossakovsky
e5ddd1193a Update README.md for clarity and consistency
- Revised project attribution to reflect the original creator.
- Enhanced descriptions for community resources and AI templates.
- Updated terminology for improved clarity regarding local model interactions and file access.
- Streamlined language throughout the document to enhance readability.
2025-05-08 16:26:40 -06:00
Yury Kossakovsky
1f680e2af7 Remove outdated monitoring section from README.md to streamline content and improve clarity. This change eliminates unnecessary details about Prometheus and Grafana setup, focusing on essential project information. 2025-05-08 16:21:52 -06:00
Yury Kossakovsky
ed46db6c21 Refactor README.md to streamline installation instructions and clarify service hostnames
- Removed outdated prerequisites and consolidated installation steps for better clarity.
- Updated service hostnames section to provide clear examples for user configuration.
- Enhanced the description of the installation script's functionality regarding secret generation and service startup.
2025-05-08 16:21:20 -06:00
Yury Kossakovsky
f624310911 Refine DNS configuration and installation instructions in README.md
- Updated DNS A-record instructions to include wildcard and apex domain records for better clarity.
- Clarified the primary domain name requirement during installation to align with the new DNS setup.
- Ensured consistency in variable naming for the WEBUI_HOSTNAME in the example configuration.
2025-05-08 15:47:52 -06:00
Yury Kossakovsky
32356adcf2 Remove outdated extra steps from README.md to streamline installation instructions and improve clarity. Focus on essential prerequisites for setting up the environment. 2025-05-06 17:00:47 -06:00
Yury Kossakovsky
2b303f45fd Refine DNS configuration instructions in README.md for clarity and formatting
- Reformatted the DNS A-records section for improved readability.
- Ensured consistent presentation of domain configuration requirements for the n8n ecosystem installation.
2025-05-06 15:46:24 -06:00
Yury Kossakovsky
86bdb08b99 Update README.md to clarify project details and improve content consistency
- Removed references to external LLM API keys in the workflows section for clarity.
- Simplified language in various sections to enhance readability.
- Updated links and terminology for consistency, including renaming "Local AI Starter Kit" to "Starter Kit" and "Local AI community" to "Community".
2025-05-06 09:14:17 -06:00
Yury Kossakovsky
c41cf5c0b7 Enhance installation instructions in README.md with detailed prerequisites and updated script usage
- Added a section on prerequisites before installation, including domain name and DNS configuration requirements.
- Clarified the installation process and emphasized the need for a Linux server.
- Updated the script usage instructions to reflect changes in the installation process and included prompts for user input during setup.
2025-05-05 15:56:38 -06:00
Yury Kossakovsky
7c56ddc2f4 Update installation instructions in README.md to reflect new script usage for setup 2025-05-05 14:05:21 -06:00