Welcome to the Codenode Documentation

The codenode homepage is at codenode.org.

The codenode code repository, wiki, and bug tracker is here: github.com/codenode/codenode.

If you have additional questions, find an error, or want to get involved, please post here: codenode-devel mailing list!

Getting Started

Quickstart (how to run code): Here.

Install: Here.

Concepts and Terminology: Here.

Table of Contents

• How to use codenode
  • Quickstart, in 3 easy steps
  • Using codenode
• Important Concepts and Terminology
  • The Bookshelf
  • The Notebook
  • Glossary of key terms in codenode
• The Bookshelf
  • Create a new Notebook
  • Search
  • Sorting and Viewing
  • Folders
  • Archive
  • Deleting Notebooks
  • Attach
• The Notebook
  • Notebook Topbar - Buttons and Options
  • Notebook Cells - Functionality and Structure
    • Cell Functionality - How to use Cells effectively
    • Cell Components and Types
    • Cell Sections and Grouping
    • Brackets
• Settings for Users and Admins
  • User Settings
  • Admin Interface and Settings
• Installing codenode
  • Fast install
  • Recommended install
  • Advanced install
  • Deploying With Remote Backend(s)
  • Dependencies
• Commands For Running and Managing Codenode
  • The codenode Command Line Admin Tool
    • django-admin.py
    • twistd
  • Development Command Tools
• The Backend
  • Backend Server
  • Engine
    • Engine Plug-in files
• Optimizing codenode for Efficiency, Scaleability, and Security
  • Make codenode fast for users, in terms of page loading time
  • Run codenode under a reverse proxy
• Developing Codenode
  • Hackable Components
    • Overview
  • Server scripts
  • Devel environment and database
  • Devel mode example
  • Manhole
• Motivation and philosophy of codenode
  • Core ideas, user focused
  • Core ideas, developer focused