sdevch/tiddlywiki repository overview

⁠TiddlyWiki Docker Deployment

This repository provides all necessary files to deploy TiddlyWiki, a non-linear personal web notebook, as a Docker container. The setup process is streamlined, enabling you to quickly get TiddlyWiki running on your system.

⁠Overview

• TiddlyWiki: A flexible and customizable wiki tool for personal note-taking, task management, and documentation.
• Docker: A platform for developing, shipping, and running applications in containers, ensuring consistent environments.

⁠Features

• Automated Deployment: Use the included deploy.sh script to effortlessly build the Docker image and set up the container.
• Persistent Storage: TiddlyWiki data is stored using Docker volumes, preserving your information even after container restarts or removals.
• Customizable Configuration: Modify environment variables to adjust TiddlyWiki settings such as WIKI_NAME and PORT.
• User Authentication: Secure your TiddlyWiki with a username and password for access control.

⁠Prerequisites

Before deploying TiddlyWiki, ensure you have the following installed on your machine:

• Docker: Install Docker by following the official installation guide⁠ for your operating system.

⁠Download the Repository

Download the repository containing the deployment files. You can clone it using Git or download it as a ZIP file.

⁠Using Git

git clone https://github.com/sdev-ch/tiddlywiki-docker.git
cd tiddlywiki-docker

⁠Download ZIP

You can download the ZIP file directly from the repository here⁠ and extract it to your desired location.

⁠Quick Start with deploy.sh

1. Navigate to the project directory: Open a terminal and navigate to the directory containing the downloaded files:

   cd path/to/tiddlywiki-docker
   

   Copy

2. Make the script executable: Run the following command to make the deployment script executable:

   chmod +x deploy.sh
   

   Copy

3. Run the deployment script: Execute the deployment script using:

   ./deploy.sh
   

   Copy

   You will be prompted to enter a username and password for TiddlyWiki access.

4. Access TiddlyWiki: Open a web browser and navigate to http://localhost:8080⁠ to view the TiddlyWiki interface.

⁠Environment Variables

You can customize the TiddlyWiki configuration by setting the following environment variables in the deploy.sh script:

• WIKI_NAME: The name of your TiddlyWiki (default: "mywiki").
• PORT: The port on which TiddlyWiki will run (default: 8080).
• NODE_MEM: The maximum memory allocated to Node.js (in MB).
• ROOT_TIDDLER: The name of the root tiddler for saving (default: "$:/core/save/all").
• RENDER_TYPE: The type of rendering (default: "text/plain").
• SERVE_TYPE: The content type served (default: "text/html").
• USERNAME: The username for accessing the wiki (default: "anonymous").
• PASSWORD: The password for accessing the wiki (default: empty).
• HOST: The host IP address (default: "0.0.0.0").
• PATH_PREFIX: The URL path prefix (default: empty).

⁠Data Storage

TiddlyWiki stores its data in a Docker volume named tiddlywiki_data, mounted at /var/lib/tiddlywiki. This ensures:

• Your data persists across container restarts and updates.
• Easy backup of your TiddlyWiki data.

⁠Backing Up Data

To back up your data, run:

docker run --rm -v tiddlywiki_data:/data busybox tar czf /backup/tiddlywiki_backup.tar.gz -C /data .

Make sure to replace /backup/tiddlywiki_backup.tar.gz with your desired backup path.

⁠Stopping and Removing the Container

If you need to stop or remove the TiddlyWiki container, use:

docker stop tiddlywiki_instance
docker rm tiddlywiki_instance

⁠Troubleshooting

• Ensure Docker is running and that you have sufficient permissions to execute Docker commands.
• If you encounter issues, check the logs of the running container using:

  docker logs tiddlywiki_instance
  

  Copy

⁠License

This project is licensed under the MIT License - see the LICENSE file for details.

⁠Acknowledgments

Thanks to TiddlyWiki⁠ for providing this powerful personal wiki system and to the Docker community for their support and tools that make deployment easier.