alextselegidis/plainpad repository overview

⁠Plainpad Docker

⁠ A self-hosted, open source note taking application that can be installed on your server.

About⁠ • Features⁠ • Setup⁠ • Installation⁠ • License⁠

⁠About

Plainpad is a self-hosted, open source note taking application that prioritizes simplicity and privacy. It allows you to create, organize, and manage your notes through a clean and intuitive web interface. As an open source project, you can download and install it even for commercial use. Plainpad gives you complete control over your data, running entirely on your own server without any third-party dependencies.

⁠Features

The application is designed to provide a distraction-free note-taking experience with essential features:

• Clean and intuitive user interface.
• Markdown support for formatting.
• Note organization and search.
• Self-hosted installation.
• Complete data ownership and privacy.
• Multi-user support.
• Responsive design for mobile and desktop.
• Open source and customizable.

⁠Setup

To clone and run this application, you'll need a MySQL database. From your command line:

# Start a MySQL instance
$ docker run -d --name test-db -e MYSQL_ROOT_PASSWORD=secret -e MYSQL_DATABASE=plainpad mysql:latest

# Pull and run the app
$ docker run --name test-app -d --link test-db:db -p 80:80 -e DB_HOST=db -e DB_NAME=plainpad -e DB_USERNAME=root -e DB_PASSWORD=secret alextselegidis/plainpad:latest

Note: If you're using Linux Bash for Windows, see this guide⁠ or use node from the command prompt.

⁠Database Migration

After the application is booted, run the following command to migrate the database:

docker exec -it test-app php artisan migrate:fresh --seed --force

⁠Docker Compose

You can use the following docker-compose.yml file to locally set up Plainpad with a MySQL database:

services:
  plainpad:
    image: alextselegidis/plainpad:1.0.0
    ports:
      - '80:80'
    environment:
      - BASE_URL=http://localhost
      - DEBUG_MODE=TRUE
      - DB_HOST=mysql
      - DB_NAME=plainpad
      - DB_USERNAME=root
      - DB_PASSWORD=secret
      - MAIL_PROTOCOL=smtp
      - MAIL_SMTP_DEBUG=0
      - MAIL_SMTP_AUTH=0
      - MAIL_SMTP_USER=
      - MAIL_SMTP_HOST=smtp.example.org
      - MAIL_SMTP_PASS=
      - MAIL_SMTP_CRYPTO=ssl
      - MAIL_SMTP_PORT=465
      - [email protected]
      - MAIL_FROM_NAME=Example
      - [email protected]
  mysql:
    image: mysql:8.0
    environment:
      - MYSQL_ROOT_PASSWORD=secret
      - MYSQL_DATABASE=plainpad     

⁠License

Code Licensed Under GPL v3.0⁠ | Content Under CC BY 3.0⁠

Website alextselegidis.com⁠  ·  GitHub alextselegidis⁠  ·  Twitter @alextselegidis⁠