Git Product home page Git Product logo

muon's Introduction

	 _ __ ___  _   _  ___  _ __  
	| '_ ` _ \| | | |/ _ \| '_ \ 
	| | | | | | |_| | (_) | | | |
	|_| |_| |_|\__,_|\___/|_| |_|

   The wiki built on Windows Azure 

Try Muon out (read only): http://muon.azurewebsites.net

Features

  1. Directly upload/download content from Azure Storage, allowing high scale at low cost.
  2. Integrates with twitter for authentication.
  3. Allow public read/write access, or limit access to selected users.
  4. Use markdown to edit articles.
  5. Ideal for small teams collaborating on documentation.
  6. It's really fast and simple!

Installation instructions

Prerequisites:

The application will use Twitter to authenticate users (unless you choose to make the wiki fully public read/write access). You will need to sign up for a twitter developer account, and register an application. Your application key and secret can then be used for Muon.

1. Create a storage account in Windows Azure

You can either do this in the Portal, or using the command line:

azure account storage create --location "North Europe" THE_NAME_OF_YOUR_STORAGE_ACCOUNT

2. Create a website

You can either do this in the Portal, or using the command line. You must enable Git publishing.

azure site create NAME_OF_YOUR_WEBSITE --git --location "North Europe"

3. Deploy the website

Use git to clone Muon, and publish it to your website:

git clone https://github.com/richorama/muon.git
cd muon
git remote add azure https://NAME_OF_YOUR_WEBSITE.scm.azurewebsites.net/NAME_OF_YOUR_WEBSITE.git
git push azure master

4. Configure Muon

Muon uses a number of app settings to configure the permissions and settings. You can create these on the command line or enter them into the Portal:

setlocal
set site=NAME_OF_YOUR_WEBSITE

azure site config add storageaccount=THE_NAME_OF_YOUR_STORAGE_ACCOUNT %site%
azure site config add storagekey=YOUR_STORAGE_KEY %SITE%
azure site config add readers=* %site%
azure site config add editors=* %site%
azure site config add twitterkey=TWITTER_APP_KEY %site%
azure site config add twittersecret=TWITTER_APP_SECRET %site%

The setting are as follows:

storageaccount : The name of your window Azure Storage Account

storagekey : The key for your window Azure Storage Account

readers : * to allow public read access, otherwise a comma separated list of twitter usernames for read access

editors : * to allow public write access, otherwise a comma separated list of twitter usernames for write access

twitterkey : The key for an app you have registered in twitter (only required if you don't have * for editors and readers)

twittersecret : The secret for an app you have registered in twitter (only required if you don't have * for editors and readers)

The portal should look something like this:

Screenshot of the Windows Azure Portal

muon's People

Contributors

richorama avatar

Watchers

 avatar James Cloos avatar  avatar

Forkers

schallis

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.