Minimalist Web Notepad
Go to file
Pere Orga 1e6431ef67 perf: optimize favicon.svg 2023-11-30 22:19:44 +01:00
_tmp Revert "Improve paths for Docker (#42)" 2021-08-14 20:23:21 +02:00
.gitignore chore: add .gitignore with default tmp directory 2023-07-29 09:43:35 +00:00
.htaccess fix(.htaccess): allow passing raw parameter 2023-07-29 09:46:39 +00:00
README.md docs(README): document usage on the CLI 2023-10-09 09:48:25 +02:00
favicon.ico perf: optimize favicon.ico 2023-11-28 19:23:42 +01:00
favicon.svg perf: optimize favicon.svg 2023-11-30 22:19:44 +01:00
index.php allow modify pad by posting raw data 2023-10-09 14:23:59 +08:00
script.js Improve wording in comments 2023-03-04 10:56:11 +01:00
styles.css css: remove old prefixes 2020-07-19 00:39:27 +02:00

README.md

Minimalist Web Notepad

This is an open-source clone of the now-defunct notepad.cc: "a piece of paper in the cloud".

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

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 the project resides in the root directory:

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

If the project resides in a subdirectory:

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

Usage (CLI)

Using the command-line interface you can both save and retrieve notes. Here are some examples using curl:

Retrieve a note's content and save it to a local file:

curl https://example.com/notes/test > test.txt

Save specific text to a note:

curl https://example.com/notes/test -d 'hello,

welcome to my pad!
'

Save the content of a local file (e.g., /etc/hosts) to a note:

cat /etc/hosts | curl https://example.com/notes/hosts --data-binary @-

Other examples

There are git branches with examples using Docker and the Web Crypto API.

Copyright 2012 Pere Orga pere@orga.cat

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.