Upadtes to documentation and website in general

This commit is contained in:
2025-05-13 11:06:26 -06:00
parent 771353a8e7
commit 47e5d1583f
68 changed files with 8539 additions and 809 deletions

1
mkdocs/docs/.obsidian/app.json vendored Normal file
View File

@@ -0,0 +1 @@
{}

1
mkdocs/docs/.obsidian/appearance.json vendored Normal file
View File

@@ -0,0 +1 @@
{}

31
mkdocs/docs/.obsidian/core-plugins.json vendored Normal file
View File

@@ -0,0 +1,31 @@
{
"file-explorer": true,
"global-search": true,
"switcher": true,
"graph": true,
"backlink": true,
"canvas": true,
"outgoing-link": true,
"tag-pane": true,
"properties": false,
"page-preview": true,
"daily-notes": true,
"templates": true,
"note-composer": true,
"command-palette": true,
"slash-command": false,
"editor-status": true,
"bookmarks": true,
"markdown-importer": false,
"zk-prefixer": false,
"random-note": false,
"outline": true,
"word-count": true,
"slides": false,
"audio-recorder": false,
"workspaces": false,
"file-recovery": true,
"publish": false,
"sync": true,
"webviewer": false
}

173
mkdocs/docs/.obsidian/workspace.json vendored Normal file
View File

@@ -0,0 +1,173 @@
{
"main": {
"id": "cc8b9bc9300e924f",
"type": "split",
"children": [
{
"id": "ffae4535d3cb6390",
"type": "tabs",
"children": [
{
"id": "9a77916c377f10c9",
"type": "leaf",
"state": {
"type": "markdown",
"state": {
"file": "testing.md",
"mode": "source",
"source": false
},
"icon": "lucide-file",
"title": "testing"
}
}
]
}
],
"direction": "vertical"
},
"left": {
"id": "0888ce71a20e3033",
"type": "split",
"children": [
{
"id": "ca01f288e6af3ccf",
"type": "tabs",
"children": [
{
"id": "ad1e497e508614b5",
"type": "leaf",
"state": {
"type": "file-explorer",
"state": {
"sortOrder": "alphabetical",
"autoReveal": false
},
"icon": "lucide-folder-closed",
"title": "Files"
}
},
{
"id": "22ccbaa12e9fe452",
"type": "leaf",
"state": {
"type": "search",
"state": {
"query": "",
"matchingCase": false,
"explainSearch": false,
"collapseAll": false,
"extraContext": false,
"sortOrder": "alphabetical"
},
"icon": "lucide-search",
"title": "Search"
}
},
{
"id": "6ee8e33cbf1b625c",
"type": "leaf",
"state": {
"type": "bookmarks",
"state": {},
"icon": "lucide-bookmark",
"title": "Bookmarks"
}
}
]
}
],
"direction": "horizontal",
"width": 300
},
"right": {
"id": "e8f39a50df63b264",
"type": "split",
"children": [
{
"id": "e0f2e9d49bf301d5",
"type": "tabs",
"children": [
{
"id": "745e41038f228e00",
"type": "leaf",
"state": {
"type": "backlink",
"state": {
"file": "testing.md",
"collapseAll": false,
"extraContext": false,
"sortOrder": "alphabetical",
"showSearch": false,
"searchQuery": "",
"backlinkCollapsed": false,
"unlinkedCollapsed": true
},
"icon": "links-coming-in",
"title": "Backlinks for testing"
}
},
{
"id": "7b91c5d16a1df1c3",
"type": "leaf",
"state": {
"type": "outgoing-link",
"state": {
"file": "testing.md",
"linksCollapsed": false,
"unlinkedCollapsed": true
},
"icon": "links-going-out",
"title": "Outgoing links from testing"
}
},
{
"id": "f284d9f76da70179",
"type": "leaf",
"state": {
"type": "tag",
"state": {
"sortOrder": "frequency",
"useHierarchy": true,
"showSearch": false,
"searchQuery": ""
},
"icon": "lucide-tags",
"title": "Tags"
}
},
{
"id": "31e48c2055d36ef0",
"type": "leaf",
"state": {
"type": "outline",
"state": {
"file": "testing.md",
"followCursor": false,
"showSearch": false,
"searchQuery": ""
},
"icon": "lucide-list",
"title": "Outline of testing"
}
}
]
}
],
"direction": "horizontal",
"width": 300,
"collapsed": true
},
"left-ribbon": {
"hiddenItems": {
"switcher:Open quick switcher": false,
"graph:Open graph view": false,
"canvas:Create new canvas": false,
"daily-notes:Open today's daily note": false,
"templates:Insert template": false,
"command-palette:Open command palette": false
}
},
"active": "9a77916c377f10c9",
"lastOpenFiles": []
}

View File

@@ -1,17 +1,144 @@
# Applications Overview
# Changemaker V5 - Apps & Services Documentation
# Testing this sucker out
This document provides an overview of all the applications and services included in the Changemaker V5 productivity suite, along with links to their documentation.
## Dashboard
### Homepage
- **Description**: Main dashboard for Changemaker V5
- **Documentation**: [Homepage Docs](https://gethomepage.dev/)
- **Local Access**: http://localhost:3010/
- **Details**: Homepage serves as your central command center, providing a unified dashboard to access all Changemaker services from one place. It features customizable layouts, service status monitoring, and bookmarks to frequently used pages, eliminating the need to remember numerous URLs.
Changemaker V5 includes a suite of powerful, self-hosted applications to boost your productivity and control your digital presence. Explore the applications below to learn more about their features and how to use them.
## Essential Tools
## Core Applications
### Code Server
- **Description**: Visual Studio Code in the browser
- **Documentation**: [Code Server Docs](https://coder.com/docs/code-server)
- **Local Access**: http://localhost:8888/
- **Details**: Code Server brings the power of VS Code to your browser, allowing you to develop and edit code from any device without local installation. This makes it perfect for quick edits to website content, fixing formatting issues, or developing from tablets or borrowed computers. The familiar VS Code interface includes extensions, syntax highlighting, and Git integration.
- [**Homepage Dashboard**](apps/homepage.md): Your central command center for all Changemaker services.
- [**Code Server**](apps/code-server.md): Visual Studio Code in your browser for easy code editing and development.
- [**Flatnotes**](apps/flatnotes.md): Simple, markdown-based note-taking, directly connected to your blog.
- [**Listmonk**](apps/listmonk.md): Self-hosted newsletter and mailing list manager.
- [**NocoDB**](apps/nocodb.md): Open Source Airtable Alternative, turning databases into smart spreadsheets.
### Flatnotes
- **Description**: Simple note-taking app - connected directly to blog
- **Documentation**: [Flatnotes Docs](https://github.com/Dullage/Flatnotes)
- **Local Access**: http://localhost:8089/
- **Details**: Flatnotes offers distraction-free, markdown-based note-taking with automatic saving and powerful search. Perfect for capturing ideas that can be directly published to your blog without reformatting. Use it for drafting newsletters, documenting processes, or maintaining a knowledge base that's both private and publishable.
Click on each application to navigate to its dedicated documentation page.
### Listmonk
- **Description**: Self-hosted newsletter and mailing list manager
- **Documentation**: [Listmonk Docs](https://listmonk.app/docs/)
- **Local Access**: http://localhost:9000/
- **Details**: Listmonk provides complete control over your email campaigns without subscription fees or content restrictions. Create segmented lists, design professional newsletters, track engagement metrics, and manage opt-ins/unsubscribes—all while keeping your audience data private. Perfect for consistent communication with supporters without the censorship risks or costs of commercial platforms.
### NocoDB
- **Description**: Open Source Airtable Alternative
- **Documentation**: [NocoDB Docs](https://docs.nocodb.com/)
- **Local Access**: http://localhost:8090/
- **Details**: NocoDB transforms any database into a smart spreadsheet with advanced features like forms, views, and automations. Use it to create volunteer signup systems, event management databases, or campaign tracking tools without subscription costs. Its familiar spreadsheet interface makes it accessible to non-technical users while providing the power of a relational database.
## Content Creation
### MkDocs - Material Theme
- **Description**: Static site generator and documentation builder
- **Documentation**: [MkDocs Docs](https://www.mkdocs.org/)
- **Local Access**: http://localhost:4000/
- **Details**: MkDocs with Material theme transforms simple markdown files into beautiful, professional documentation sites. Ideal for creating campaign websites, project documentation, or public-facing content that loads quickly and ranks well in search engines. The Material theme adds responsive design, dark mode, and advanced navigation features.
### Excalidraw
- **Description**: Virtual collaborative whiteboard for sketching and drawing
- **Documentation**: [Excalidraw Docs](https://github.com/excalidraw/excalidraw)
- **Local Access**: http://localhost:3333/
- **Details**: Excalidraw provides a virtual whiteboard for creating diagrams, flowcharts, or sketches with a hand-drawn feel. It's excellent for visual brainstorming, planning project workflows, or mapping out campaign strategies. Multiple people can collaborate in real-time, making it ideal for remote team planning sessions.
### Gitea
- **Description**: Lightweight self-hosted Git service
- **Documentation**: [Gitea Docs](https://docs.gitea.io/)
- **Local Access**: http://localhost:3030/
- **Details**: Gitea provides a complete code and document version control system similar to GitHub but fully under your control. Use it to track changes to campaign materials, collaborate on content development, manage website code, or maintain configuration files with full revision history. Multiple contributors can work together without overwriting each other's changes.
### OpenWebUI
- **Description**: Web interface for Ollama
- **Documentation**: [OpenWebUI Docs](https://docs.openwebui.com/)
- **Local Access**: http://localhost:3005/
- **Details**: OpenWebUI provides a user-friendly chat interface for interacting with your Ollama AI models. This makes AI accessible to non-technical team members for tasks like drafting responses, generating creative content, or researching topics. The familiar chat format allows anyone to leverage AI assistance without needing to understand the underlying technology.
## Community & Data
### Monica CRM
- **Description**: Personal relationship management system
- **Documentation**: [Monica Docs](https://www.monicahq.com/docs)
- **Local Access**: http://localhost:8085/
- **Details**: Monica CRM helps you maintain meaningful relationships by tracking interactions, important dates, and personal details about contacts. It's perfect for community organizers to remember conversation contexts, follow up appropriately, and nurture connections with supporters. Unlike corporate CRMs, Monica focuses on the human aspects of relationships rather than just sales metrics.
### Answer
- **Description**: Q&A platform for teams
- **Documentation**: [Answer Docs](https://answer.dev/docs)
- **Local Access**: http://localhost:9080/
- **Details**: Answer creates a knowledge-sharing community where team members or supporters can ask questions, provide solutions, and vote on the best responses. It builds an organized, searchable knowledge base that grows over time. Use it for internal team support, public FAQs, or gathering community input on initiatives while keeping valuable information accessible rather than buried in email threads.
### Ferdium
- **Description**: All-in-one messaging application
- **Documentation**: [Ferdium Docs](https://ferdium.org/help)
- **Local Access**: http://localhost:3002/
- **Details**: Ferdium consolidates all your communication platforms (Slack, Discord, WhatsApp, Telegram, etc.) into a single interface. This allows you to monitor and respond across channels without constantly switching applications. Perfect for community managers who need to maintain presence across multiple platforms without missing messages or getting overwhelmed.
### Rocket.Chat
- **Description**: Team collaboration platform with chat, channels, and video conferencing
- **Documentation**: [Rocket.Chat Docs](https://docs.rocket.chat/)
- **Local Access**: http://localhost:3004/
- **Details**: Rocket.Chat provides a complete communication platform for your team or community. Features include real-time chat, channels, direct messaging, file sharing, video calls, and integrations with other services. It's perfect for creating private discussion spaces, coordinating campaigns, or building community engagement. Unlike commercial platforms, you maintain full data sovereignty and control over user privacy.
## Development
### Ollama
- **Description**: Local AI model server for running large language models
- **Documentation**: [Ollama Docs](https://ollama.ai/docs)
- **Local Access**: http://localhost:11435/
- **Details**: Ollama runs powerful AI language models locally on your server, providing AI capabilities without sending sensitive data to third-party services. Use it for content generation, research assistance, or data analysis with complete privacy. Models run on your hardware, giving you full control over what AI can access and ensuring your information stays confidential.
### Portainer
- **Description**: Docker container management UI
- **Documentation**: [Portainer Docs](https://docs.portainer.io/)
- **Local Access**: https://localhost:9443/
- **Details**: Portainer simplifies Docker management with a visual interface for controlling containers, images, networks, and volumes. Instead of complex command-line operations, you can start/stop services, view logs, and manage resources through an intuitive UI, making system maintenance accessible to non-technical users.
### Mini-QR
- **Description**: QR Code Generator
- **Documentation**: [Mini-QR Docs](https://github.com/xbzbing/mini-qr)
- **Local Access**: http://localhost:8081/
- **Details**: Mini-QR enables you to quickly generate customizable QR codes for any URL, text, or contact information. Perfect for campaign materials, business cards, or event signage. Create codes that link to your digital materials without relying on third-party services that may track usage or expire.
### ConvertX
- **Description**: Self-hosted file conversion tool
- **Documentation**: [ConvertX GitHub](https://github.com/c4illin/convertx)
- **Local Access**: http://localhost:3100/
- **Details**: ConvertX provides a simple web interface for converting files between different formats. It supports a wide range of file types including documents, images, audio, and video. This enables you to maintain full control over your file conversions without relying on potentially insecure third-party services. Perfect for converting documents for campaigns, optimizing images for web use, or preparing media files for different platforms.
### n8n
- **Description**: Workflow automation platform
- **Documentation**: [n8n Docs](https://docs.n8n.io/)
- **Local Access**: http://localhost:5678/
- **Details**: n8n automates repetitive tasks by connecting your applications and services with visual workflows. You can create automations like sending welcome emails to new supporters, posting social media updates across platforms, or synchronizing contacts between databases—all without coding. This saves hours of manual work and ensures consistent follow-through on processes.
## Remote Access
When configured with Cloudflare Tunnels, you can access these services remotely at:
- Homepage: https://homepage.yourdomain.com
- Excalidraw: https://excalidraw.yourdomain.com
- Listmonk: https://listmonk.yourdomain.com
- Monica CRM: https://monica.yourdomain.com
- MkDocs: https://yourdomain.com
- Flatnotes: https://flatnotes.yourdomain.com
- Code Server: https://code-server.yourdomain.com
- Ollama: https://ollama.yourdomain.com
- OpenWebUI: https://open-web-ui.yourdomain.com
- Gitea: https://gitea.yourdomain.com
- Portainer: https://portainer.yourdomain.com
- Mini QR: https://mini-qr.yourdomain.com
- Ferdium: https://ferdium.yourdomain.com
- Answer: https://answer.yourdomain.com
- NocoDB: https://nocodb.yourdomain.com
- n8n: https://n8n.yourdomain.com
- ConvertX: https://convertx.yourdomain.com
- Rocket.Chat: https://rocket.yourdomain.com

View File

@@ -12,6 +12,10 @@ Answer is a self-hosted, open-source Q&A platform designed to help teams and com
* **Markdown Support**: Write questions and answers using Markdown.
* **Self-Hosted**: Full control over your data and platform.
## Documentation
For more detailed information about Answer, visit the [official documentation](https://answer.apache.org/docs/).
## Getting Started with Answer
### Accessing Answer

View File

@@ -13,6 +13,10 @@ It's an essential tool within Changemaker for making quick edits to your website
* **Integrated Terminal**: Access a terminal directly within the browser interface.
* **Git Integration**: Manage your version control seamlessly.
## Documentation
For more detailed information about Code Server, visit the [official repository](https://github.com/coder/code-server).
## Getting Started with Code Server
### Accessing Code Server

View File

@@ -11,6 +11,10 @@ Excalidraw is a virtual collaborative whiteboard tool that lets you easily sketc
* **Library Support**: Create and use libraries of reusable components.
* **Self-Hosted**: As part of Changemaker, your Excalidraw instance is self-hosted, keeping your data private.
## Documentation
For more detailed information about Excalidraw, visit the [official repository](https://github.com/excalidraw/excalidraw).
## Getting Started with Excalidraw
### Accessing Excalidraw

View File

@@ -15,6 +15,10 @@ Assuming it's accessible via a web URL in your Changemaker instance:
* **Cross-Platform**: Available for Windows, macOS, and Linux (as a desktop app).
* **Open Source**: Community-driven development.
## Documentation
For more detailed information about Ferdium, visit the [official repository](https://github.com/ferdium/ferdium-app).
## Getting Started with Ferdium (Web Access within Changemaker)
### Accessing Ferdium (If Web-Accessible)

View File

@@ -13,6 +13,10 @@ Flatnotes is a straightforward, self-hosted, markdown-based note-taking applicat
* **Self-Hosted**: Your notes remain private on your server.
* **Potential Blog Integration**: Notes can be easily copied or potentially directly published to your MkDocs site or other blog platforms that use Markdown.
## Documentation
For more detailed information about Flatnotes, visit the [official repository](https://github.com/dullage/flatnotes).
## Getting Started with Flatnotes
### Accessing Flatnotes

View File

@@ -12,6 +12,10 @@ Gitea is a lightweight, self-hosted Git service. It provides a web interface for
* **Self-Hosted**: Full control over your data and infrastructure.
* **Web Interface**: User-friendly interface for common Git operations.
## Documentation
For more detailed information about Gitea, visit the [official documentation](https://docs.gitea.com/).
## Getting Started with Gitea
### Accessing Gitea

View File

@@ -13,6 +13,10 @@ Listmonk is a powerful, self-hosted newsletter and mailing list manager. It give
* **API Access**: Integrate Listmonk with other systems programmatically.
* **Multi-lingual**: Supports multiple languages.
## Documentation
For more detailed information about Listmonk, visit the [official documentation](https://listmonk.app/docs/).
## Getting Started with Listmonk
### Accessing Listmonk

View File

@@ -12,6 +12,10 @@ Changemaker V5 utilizes MkDocs with the Material theme to build this very docume
* **Plugin Ecosystem**: Extend MkDocs with various plugins (e.g., for blog functionality, social cards, diagrams).
* **Live Reload Server**: `mkdocs serve` provides a development server that automatically reloads when you save changes.
## Documentation
For more detailed information about MkDocs, visit the [official documentation](https://www.mkdocs.org/).
## Editing This Site (Your Changemaker Documentation)
All content for this documentation site is managed as Markdown files within the `mkdocs/docs/` directory of your Changemaker project.

View File

@@ -11,6 +11,10 @@ Monica CRM is a self-hosted, open-source personal relationship management system
* **Data Ownership**: Self-hosted, so you control your data.
* **Focus on Personal Connections**: Designed to strengthen personal relationships.
## Documentation
For more detailed information about Monica CRM, visit the [official documentation](https://www.monicahq.com/documentation/).
## Getting Started with Monica CRM
### Accessing Monica CRM

66
mkdocs/docs/apps/n8n.md Normal file
View File

@@ -0,0 +1,66 @@
# n8n: Automate Your Workflows
n8n is a powerful workflow automation platform that allows you to connect different services and systems together without needing complex programming skills. Within Changemaker V5, it enables you to create automated processes that save time and ensure consistency across your operations.
## Key Features
* **Visual Workflow Builder**: Create automation flows using an intuitive drag-and-drop interface.
* **Pre-built Integrations**: Connect to hundreds of services including email, social media, databases, and more.
* **Custom Functionality**: Create your own nodes for custom integrations when needed.
* **Scheduling**: Run workflows on schedules or trigger them based on events.
* **Error Handling**: Configure what happens when steps fail, with options to retry or alert.
* **Self-hosted**: Keep your automation data and credentials completely under your control.
* **Credential Management**: Securely store and reuse authentication details for various services.
## Documentation
For more detailed information about n8n, visit the [official documentation](https://docs.n8n.io/).
## Getting Started with n8n
### Accessing n8n
1. **URL**: You can access n8n locally via `http://localhost:5678/` (or your configured external URL if set up).
2. **Authentication**: The first time you access n8n, you'll need to set up an account with admin credentials.
### Basic Usage
1. **Creating Your First Workflow**:
* Click the "+" button in the top right to create a new workflow.
* Add a trigger node (e.g., "Schedule" for time-based triggers or "Webhook" for event-based triggers).
* Connect additional nodes for the actions you want to perform.
* Save your workflow and activate it using the toggle at the top of the editor.
2. **Example Workflow: Automatic Welcome Emails**
* Start with a "Webhook" node that triggers when a new contact is added to your system.
* Connect to an "Email" node configured to send your welcome message.
* Optionally, add a "Slack" or "Rocket.Chat" node to notify your team about the new contact.
3. **Common Use Cases**:
* **Content Publishing**: Automatically post blog updates to social media channels.
* **Data Synchronization**: Keep contacts in sync between different systems.
* **Event Management**: Send reminders before events and follow-ups afterward.
* **Monitoring**: Get notifications when important metrics change or thresholds are reached.
* **Form Processing**: Automatically handle form submissions with confirmation emails and data storage.
### Integration with Other Changemaker Services
n8n works particularly well with other services in your Changemaker environment:
* **NocoDB**: Connect to your databases to automate record creation, updates, or data processing.
* **Listmonk**: Trigger email campaigns based on events or schedules.
* **Gitea**: Automate responses to code changes or issue creation.
* **Monica CRM**: Update contact records automatically when interactions occur.
* **Rocket.Chat**: Send automated notifications to team channels.
## Advanced Features
* **Error Handling**: Configure error workflows and retries for increased reliability.
* **Splitting and Merging**: Process multiple items in parallel and then combine results.
* **Expressions**: Use JavaScript expressions for dynamic data manipulation.
* **Webhooks**: Create endpoints that can receive data from external services.
* **Function Nodes**: Write custom JavaScript code for complex data transformations.
* **Cron Jobs**: Schedule workflows to run at specific intervals.
## Further Information
For more detailed information on creating complex workflows, available integrations, and best practices, please refer to the [official n8n Documentation](https://docs.n8n.io/).

View File

@@ -13,6 +13,10 @@ NocoDB is a powerful open-source alternative to services like Airtable. It allow
* **Self-Hosted**: Maintain full control over your data and infrastructure.
* **No-Code/Low-Code**: Build simple applications and workflows with minimal to no coding.
## Documentation
For more detailed information about NocoDB, visit the [official documentation](https://docs.nocodb.com/).
## Getting Started with NocoDB
### Accessing NocoDB

View File

@@ -11,6 +11,10 @@ Ollama is a tool that allows you to run large language models (LLMs) locally on
* **Growing Model Library**: Access a growing library of popular open-source models.
* **Customization**: Create custom model files (Modelfiles) to tailor model behavior.
## Documentation
For more detailed information about Ollama, visit the [official repository](https://github.com/ollama/ollama).
## Getting Started with Ollama (within Changemaker)
Ollama itself is primarily a command-line tool and an API server. You typically interact with it via a terminal or through a UI like OpenWebUI.

View File

@@ -11,6 +11,10 @@ OpenWebUI provides a user-friendly, web-based chat interface for interacting wit
* **Self-Hosted**: Runs locally as part of your Changemaker suite, ensuring data privacy.
* **Markdown Support**: Renders model responses that include Markdown for better formatting.
## Documentation
For more detailed information about OpenWebUI, visit the [official documentation](https://docs.openwebui.com/).
## Getting Started with OpenWebUI
### Prerequisites

View File

@@ -13,6 +13,10 @@ Portainer is a lightweight management UI that allows you to easily manage your D
* **User-Friendly Interface**: Simplifies Docker management for users who may not be comfortable with the command line.
* **Multi-Environment Support**: Can manage multiple Docker hosts or Kubernetes clusters (though in Changemaker, it's typically managing the local Docker environment).
## Documentation
For more detailed information about Portainer, visit the [official documentation](https://docs.portainer.io/).
## Getting Started with Portainer
### Accessing Portainer

View File

@@ -13,6 +13,10 @@ Rocket.Chat is a powerful, open-source team collaboration platform. It offers a
* **Self-Hosted**: Full data sovereignty and control over user privacy.
* **Mobile and Desktop Apps**: Access Rocket.Chat from various devices.
## Documentation
For more detailed information about Rocket.Chat, visit the [official documentation](https://docs.rocket.chat/).
## Getting Started with Rocket.Chat
### Accessing Rocket.Chat

View File

@@ -0,0 +1,84 @@
# Using Ollama Models in VS Code (Code-Server)
You can integrate Ollama models with your VS Code environment (code-server) in several ways:
## Option 1: Install a VS Code Extension
The easiest approach is to install a VS Code extension that connects to Ollama:
1. In [code-server](http://localhost:8888) (your VS Code interface), open the Extensions panel
2. Search for "Continue" or "Ollama" and install an extension like "Continue" or "Ollama Chat"
3. Configure the extension to connect to Ollama using the internal Docker network URL:
```
http://ollama-changemaker:11434
```
## Option 2: Use the API Directly from the VS Code Terminal
Since the Docker CLI isn't available inside the code-server container, we can interact with the Ollama API directly using curl:
```bash
# List available models
curl http://ollama-changemaker:11434/api/tags
# Generate text with a model
curl -X POST http://ollama-changemaker:11434/api/generate -d '{
"model": "llama3",
"prompt": "Write a function to calculate Fibonacci numbers"
}'
# Pull a new model
curl -X POST http://ollama-changemaker:11434/api/pull -d '{
"name": "mistral:7b"
}'
```
## Option 3: Write Code That Uses the Ollama API
You can write scripts that connect to Ollama's API. For example, in Python:
```python
import requests
def ask_ollama(prompt, model="llama3"):
response = requests.post(
"http://ollama-changemaker:11434/api/generate",
json={"model": model, "prompt": prompt}
)
return response.json()["response"]
# Example usage
result = ask_ollama("What is the capital of France?")
print(result)
# List available models
def list_models():
response = requests.get("http://ollama-changemaker:11434/api/tags")
models = response.json()["models"]
return [model["name"] for model in models]
# Pull a new model
def pull_model(model_name):
response = requests.post(
"http://ollama-changemaker:11434/api/pull",
json={"name": model_name}
)
# This will take time for large models
return response.status_code
```
## From Your Host Machine's Terminal (Not VS Code)
If you want to use Docker commands, you'll need to run them from your host machine's terminal, not from inside VS Code:
```bash
# List available models
docker exec -it ollama-changemaker ollama list
# Pull models
docker exec -it ollama-changemaker ollama pull llama3
docker exec -it ollama-changemaker ollama pull mistral:7b
docker exec -it ollama-changemaker ollama pull codellama
```
The key is using the Docker network hostname `ollama-changemaker` with port `11434` as your connection point, which should be accessible from your code-server container since they're on the same network.

7
mkdocs/docs/testing.md Normal file
View File

@@ -0,0 +1,7 @@
# Test
# Hello World!
Compatible with any markdown editor!
Write websites quickly and with ease!