Differences between revisions 1 and 25 (spanning 24 versions)
Revision 1 as of 2015-03-18 15:47:24
Size: 3735
Editor: ?BrandonF
Comment:
Revision 25 as of 2015-03-21 17:28:33
Size: 6254
Editor: ?BrandonF
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
* '''Name:''' Brandon Fairchild  * '''Name:''' Brandon Fairchild
Line 7: Line 7:
 administration. I was a Google Summer of Code student last year on the Debian Continuous Integration Project. I have been involved in programming for the past six years. During that time I have programmed in C, Java, Python, Ruby, BASH scripting, and other languages. I have taught myself most of the languages that I know. Currently, I run Linux on all of my computers, specifically Debian. I am familiar with web development since I took some classes on the subject and practice it in my spare time and I have become familiar with databases such as MySQL and SQLite.  administration. I was a Google Summer of Code student last year on the [[http://ci.debian.net|Debian Continuous Integration Project]] and I have continued maintaining my code and adding new features as a member of the project team. I have been involved in programming for the past six years. During that time I have programmed in C, Java, Python, Ruby, BASH scripting, and other languages. I have taught myself most of the languages that I know. Currently, I run Linux on all of my computers, specifically Debian. I am familiar with web development since I took some classes on the subject and practice it in my spare time and I am comfortable working with databases such as MySQL and SQLite.
Line 17: Line 17:
The following will be done with this project: The following will be accomplished with this project:
Line 19: Line 19:
 1. '''A tool for allowing 'userops' on a Debian system:'''
      * Web interface for the tool that allows installation of web applications by users less able to get it set up by themselves and manage upgrades and security.
      * Plinth looks like a good front-end interface for the tool.
 1. '''A tool that will allow 'userops' on a Debian system:'''
      * Back-end
        * A daemon will be written in Ruby and will be controlled through the web UI front end by the end user
      * Front-end
        *
Web interface for the tool that allows installation of web applications by users less able to get it set up by themselves and manage upgrades and security.
        * The front-end of the tool will use Plinth for the UI
Line 23: Line 26:
 2. '''Recipes for configuration:'''
    
 2. '''Recipes for configuration:'''
      * Initially, the tool will support 3 popular web applications. Support will be included for OwnCloud or Wordpress (PHP), MediaGoblin (Python), and Redmine (Ruby, Rails)
      * Chef will configure and install the packages with these recipes
Line 26: Line 30:
 3. '''Documentation:'''  3. '''Patching of Debian packages'''
      * Some packages may need their config files externalized to /etc/<appname>/conf.d to prevent upgrades from breaking the configuration
 4. '''Documentation:'''
Line 32: Line 38:
 * Communicate with the initiative announced by MediaGoblin
 * Communicate with the maintainers of the packages that will be initially supported
  
by the tool
 * Communicate with the [[http://mediagoblin.org/news/userops.html|UserOps initiative]] announced by MediaGoblin 
   * http://lists.mediagoblin.org/listinfo/userops and #userops on irc.freenode.net
 *
Communicate with the maintainers of the packages that will be initially supported by the tool
Line 38: Line 44:
 * '''Benefits to Debian''': It will allow Debian users to be able to self host web applications that requires knowledge of
                            
system adminstration and web servers. This tool will simplify hosting these applications on Debian.
 * '''Benefits to Debian''': It will allow Debian users to be able to self host web applications that require knowledge of system administration and web servers. This tool will simplify hosting these applications on Debian.
Line 41: Line 46:
 * '''Deliverables''': A web interface tool allowing the installation of web applications, automated configuration of these
                      
applications, takes care of upgrades, and documentation.
 * '''Deliverables''': A tool that automates the installation, automated configuration, and upgrading of packaged web applications through a web interface presented to the user; code documentation.
Line 50: Line 54:
  * Get more familiar with Chef and other technologies needed for this
  * Communicate with the mentor, Debian community, and others (MediaGoblin 'userops' list)
  * Get more familiar with Chef, Plinth, Debian packaging, and other technologies needed for this project
  * Communicate with the mentor, the Debian community, and others ([[http://lists.mediagoblin.org/listinfo/userops|MediaGoblin UserOps mailing list]], the Debian webapps mailing list)
Line 56: Line 60:
    * '''May 25 - June 2'''
    * Work on the back-end of the automated configuration tool
  * '''June 3 - June 12'''
    * Write a Chef recipe module for a PHP web application (OwnCloud or Wordpress)
    * Test the application recipe/module and make it usable by the tool/daemon
    * Write any necessary patches for the package for config file externalization
  * '''June 13 - June 20'''
    * Write a Chef recipe module for a Python web application (MediaGoblin?)
    * Test the application recipe/module and make it usable by the tool/daemon
    * Write any necessary patches for the package for config file externalization
  * '''June 21 - June 25'''
    *
  * '''June 26 - July 3 '''
    * '''Midterm evaluations''', testing, polishing, documentation work
Line 60: Line 77:
  * '''July 4 - July 15'''
    * Get a lighttpd server running for the web UI
    * Implement the web front-end with Plinth for easily installation and configuration of packaged web applications and hook it into the back-end / daemon
  * '''July 16 - July 23'''
    * Write a Chef recipe module for a Ruby web application (Redmine)
    * Test the application recipe/module and make it usable by the tool/daemon
    * Write any necessary patches for the package for config file externalization
  * '''July 24 - July 31'''
  * '''August 1 - August 12'''
  * '''August 13 - August 20'''
    * Testing, polishing the function of the application, fix remaining bugs
  * '''August 21 - 27'''
    * '''Final evaluations'''
Line 61: Line 91:
  * '''Final evaluations''' '''AFTER GOOGLE SUMMER OF CODE'''

  * Continue the development, testing, and maintenance of the tool
  • Name: Brandon Fairchild

  • Contact/Email: csbit32 at gmail dot com, IRC: nerith on freenode/OFTC, Github: https://github.com/nerith

  • Background:I am a Computer Science student with an interest in free and open source software development and system administration. I was a Google Summer of Code student last year on the Debian Continuous Integration Project and I have continued maintaining my code and adding new features as a member of the project team. I have been involved in programming for the past six years. During that time I have programmed in C, Java, Python, Ruby, BASH scripting, and other languages. I have taught myself most of the languages that I know. Currently, I run Linux on all of my computers, specifically Debian. I am familiar with web development since I took some classes on the subject and practice it in my spare time and I am comfortable working with databases such as MySQL and SQLite. I am the best person to work on this project because I understand what needs to be accomplished, have the skills that are needed, and I am willing to learn.


Project: Automated Configuration of Packaged Web Applications

https://wiki.debian.org/SummerOfCode2015/Projects/AutoConfigWebApps


Project Details

The following will be accomplished with this project:

  1. A tool that will allow 'userops' on a Debian system:

    • Back-end
      • A daemon will be written in Ruby and will be controlled through the web UI front end by the end user
    • Front-end
      • Web interface for the tool that allows installation of web applications by users less able to get it set up by themselves and manage upgrades and security.
      • The front-end of the tool will use Plinth for the UI
  2. Recipes for configuration:

    • Initially, the tool will support 3 popular web applications. Support will be included for ?OwnCloud or Wordpress (PHP), ?MediaGoblin (Python), and Redmine (Ruby, Rails)

    • Chef will configure and install the packages with these recipes
  3. Patching of Debian packages

    • Some packages may need their config files externalized to /etc/<appname>/conf.d to prevent upgrades from breaking the configuration

  4. Documentation:

    • Documentation will be provided to allow others to test and use the tool
    • Documentation for non-technical users so that they can also understand the tool and how to use it
    • Show how to setup an instance of the tool for development purposes and usage
    • Detailed documentation on how the tool functions through the use of code comments and written documentation.
  5. Communicate with the UserOps initiative announced by ?MediaGoblin

  6. Communicate with the maintainers of the packages that will be initially supported by the tool


  • Synopsis: A tool will be created that will simplify and automate self-hosting of web applications on Debian systems.

  • Benefits to Debian: It will allow Debian users to be able to self host web applications that require knowledge of system administration and web servers. This tool will simplify hosting these applications on Debian.

  • Deliverables: A tool that automates the installation, automated configuration, and upgrading of packaged web applications through a web interface presented to the user; code documentation.


Project Schedule

[Note:] Code documentation will be done throughout the coding period.

BEFORE CODING PERIOD

  • Community Bonding:

    • Get more familiar with Chef, Plinth, Debian packaging, and other technologies needed for this project
    • Communicate with the mentor, the Debian community, and others (MediaGoblin UserOps mailing list, the Debian webapps mailing list)

CODING PERIOD 1

  • May 25 - June 2

    • Work on the back-end of the automated configuration tool
  • June 3 - June 12

    • Write a Chef recipe module for a PHP web application (?OwnCloud or Wordpress)

    • Test the application recipe/module and make it usable by the tool/daemon
    • Write any necessary patches for the package for config file externalization
  • June 13 - June 20

    • Write a Chef recipe module for a Python web application (?MediaGoblin?)

    • Test the application recipe/module and make it usable by the tool/daemon
    • Write any necessary patches for the package for config file externalization
  • June 21 - June 25

  • June 26 - July 3

    • Midterm evaluations, testing, polishing, documentation work

CODING PERIOD 2

  • July 4 - July 15

    • Get a lighttpd server running for the web UI
    • Implement the web front-end with Plinth for easily installation and configuration of packaged web applications and hook it into the back-end / daemon
  • July 16 - July 23

    • Write a Chef recipe module for a Ruby web application (Redmine)
    • Test the application recipe/module and make it usable by the tool/daemon
    • Write any necessary patches for the package for config file externalization
  • July 24 - July 31

  • August 1 - August 12

  • August 13 - August 20

    • Testing, polishing the function of the application, fix remaining bugs
  • August 21 - 27

    • Final evaluations

AFTER GOOGLE SUMMER OF CODE

  • Continue the development, testing, and maintenance of the tool


  • Exams and other commitments: I do not have any exams during the coding period.

  • Other summer plans: I have no other summer plans.

  • Why Debian?: Debian was one of the first Linux distributions that got me interested in Linux and free and open source software. It is one of my distributions of choice due to the stability and quality of releases. I want to give back to Debian for the value it has provided to me.

  • Are you applying for other projects in SoC? I am not applying for any other projects.