Skip to content

Chron-O-John/minimalist-web-notepad

 
 

Repository files navigation

Minimalist Web Notepad

This is an open source clone of notepad.cc, which is now defunct.

See demo at https://notes.orga.cat or https://notes.orga.cat/whatever.

A version that allows for optional encryption using the Web Crypto API is available at the encryption branch.

Installation

At the top of index.php file, change $base_url variable to point to your site.

Make sure the web server is allowed to write to the _tmp directory.

On Apache

You may need to enable mod_rewrite and set up .htaccess files in your site configuration. See How To Set Up mod_rewrite for Apache.

On Nginx

To enable URL rewriting, put something like this in your configuration file:

If notepad is in the root directory:

location / {
    rewrite ^/([a-zA-Z0-9_-]+)$ /index.php?note=$1;
}

If notepad is in a subdirectory:

location ~* ^/notes/([a-zA-Z0-9_-]+)$ {
    try_files $uri /notes/index.php?note=$1;
}

Docker

Build the container:

docker build -t minimalist-web-notepad .

Start the container:

docker run -d --name minimalist-web-notepad -p 80:80 minimalist-web-notepad

Show logs:

docker logs -f minimalist-web-notepad

Stop the container:

docker stop minimalist-web-notepad

Alternatively, docker-compose can also be used:

docker-compose up -d

and

docker-compose down

Environment variables

MWN_BASE_URL The base URL for redirection and assets. Defaults to ''.

MWN_SAVE_PATH The path to save the notes to. Relative paths are relative to index.php location.

Screenshots

Firefox

IE

Edge

Chrome Android

Firefox Android

Copyright and license

Copyright 2012 Pere Orga [email protected]

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

Minimalist Web Notepad

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 42.3%
  • JavaScript 27.0%
  • CSS 16.3%
  • Dockerfile 8.0%
  • Shell 6.4%