Raneto

Raneto is a free, open, simple Markdown powered knowledge base for Node.js. Find out more →

Important Updates

• Please ensure you're on Raneto v0.17.1 for the latest security fixes
• Join the Roadmap Discussion

Demo and Documentation

Visit https://docs.raneto.com to see a demo.

Quickstart

Visit the Example Repo
See the installation guide for more information.

Docker / Containers

Official Raneto container images on Docker Hub

Run the default container, and access on localhost:3000
docker run --rm -it --publish 3000:3000 raneto/raneto:latest

Same as above, but provide your own content and configuration

docker run --rm -it --publish 3000:3000 \
  --volume \
  --volume \
  raneto/raneto:latest

Want to poke around the files in the container? Get a shell:
docker run --rm -it --publish 3000:3000 --volume raneto/raneto:latest /bin/sh

Security

Make sure you edit the default username and password in your config.js file.

##### WARNING #####
// You MUST change the username and password for security
// Do NOT use "admin" as a username as it's easily guessed.
// You are encouraged to use tools to generate a password
// Preferably, use a local password manager
// If you absolutely must use an online tool, here are some suggestions
// https://bitwarden.com/password-generator/
// https://www.grc.com/passwords.htm

Markdown Reference

If you want to embed links and images, you'll need to use the Markdown syntax.
See this Markdown Guide

Links

• Configuration
• Production Notes
• Deploying to Heroku
• Contributing

Showcase

Are you using Raneto in the wild? We'd love to see it. Please add it to this list:

• Raneto Docs

Related Projects

• Default Theme
• Deploy Raneto to your servers with Ansible by @ryanlelek
• Run Raneto in a Vagrant container by @draptik
• Deploy Raneto using Docker container by @madhuakula

Credits

• Raneto was created by Gilbert Pellegrom
• Maintained by Ryan Lelek from AnsibleTutorials.com
• Logo by @mmamrila
• Released under the MIT license