Here's a sample of ideas for the 2014 GSOC application for Amahi.
This list is old and it's about to be updated for 2014.= About Amahi=
=Critical==Important==Enhancement==To be Organized===Plugin System=='''Description''We're looking for students with skills in these areas: current technologies like RoR, ruby, python, PHP, as well as next generation technologies, like Go (we use it for streaming to our mobile apps), [https://nodejs.org/ Node.js], [https://github.com/amahi/spdy HTTP/2], javascript frameworks for user interaction, visualization or server services, etc.
Make the ability to create and install '''We're also looking for hardware projects! Creating a Raspberry Pi-style device with great I/O that can run Amahi plugins easy and enable the creation of those plugins for smoothly is a variety of purposes, like SMART monitoring, system stuff (network scanning, etc.) and the two examples below long-tem goal for the disk wizard and the Greyhole UI, among other ideas.Amahi!'''
Amahi started of a need to keep a personal/home cloud server, keep all my family'''Objective'''s photos, videos, documents, and generally any data. It expanded into running applications, mostly web apps, from anything to doing backups to automatic downloaders, media managers and much more.
Create an Amahi is a full and proper server made up of* A Linux system based on a mainline distribution, currently Fedora, but we supported Ubuntu before as well* An [https://github.com/amahi plugin /hda-ctl installer] to help the user bring bring Amahi up in their system* A [https://github.com/amahi/platform platform], where PHPwhich is a web app that the user uses to manage their server, Python, Nodeadd apps* [https://www.amahi.org/apps Apps] that are installed by using the platform* Two mobile apps to access data and apps, for [http://www.amahi.org/android Android] and other modern webapps can be easily integrated[http://www.amahi. We can currently do this with some RoR engines, but the mechanism is not robust enoughorg/ios iOS].
'''Expected result'''At Amahi we use git (see our [https://github.com/amahi Github repo]) for our version management and the technologies we have ended up using are Ruby, Ruby on Rails, PHP, Linux system internal technologies like system services, configuration areas, web server virtualhosts, databases, DNS, etc., etc.
The plugins system should allow modern web-based apps = What to be easily integrated with Amahi -- from Node.js apps to Ruby/PHP/Python -- so that users can easily reap the benefits of the onslaught of difficult-to-deploy modern web apps with a single click install.ProTip: possibly leverage docker containers within Amahido (and NOT do) first =
Let's talk about what NOT to do first, because many people automatically start badly by doing these:* do '''not''' comment randomly in github issues, e.g. introducing yourself in a GH issue, saying you would like to do something, or just "make noise"* do ''Skills Required'not''' blindly try to build things without understanding what Amahi is and what it does* RoRdo '''not''' just submit a pull request or issue a bug without really knowing what you are up to* do '''Mentornot'''just come to IRC, say something and vanish shortly thereafter. Stay for a while. People come and go. Ask your question and stick around. Get a client that can linger for a while. Sometimes it takes hours for some people to return
BUT First, Introduce yourself, interact with the community, so please [https://docs.google.com/forms/d/e/1FAIpQLScP4Q2iSzLXCjz1gK2eNutO8IhX_PETXU2bL8pqmhe2t1nCqg/viewform?usp==Disk Wizard=='''Description'''sf_link introduce yourself with this form], so that we know your background and interests.
Expanding the storage capacity is an important feature of If you have questions about Amahi but as of now it requires advanced (eor just want to interact, you can contact us via IRC on [http://talk.amahi.org #amahi on irc.gfreenode. command linenet] (fairly active) or on the amahi-devel [[mailing list]] (not as active) skills. We want easy disk/partition onboardingDon't forget that we are open to suggestions, extensions or adaptations.Feel free to discuss or propose new ideas for projects!
One of the most important things is to find an area that you '''Objectiveenjoy''', using a programming environment that you know or that you are willing to learn quickly, so read below or ask questions.
Create an amahi plugin that will streamline this process by providing If you are interested in being a UI for disk managementmentor, we have a few great mentors as of today, but we're very welcoming of more ideas and more mentors!
'''Expected result'''See the [[#Mentors|mentors]] below. Looking for ideas to mentor, see the [[#Other Ideas|other ideas]] below.
The plugins should detect if a new disk was added and it should provide a wizard to create partitions and format with the desired file system=List of Project Ideas=
We have organized the ideas in groups, depending what area of Amahi they belong in. These groups are not in any particular order. For instance if you are a front-end person who knows HTML and Javascript, the GUI/UX may well be the best fit and we'''Skills Required'''* Low level system scriptingd love to hear from you!
'''Mentor'''== Platform ==
* Dag, Bogdan===Plugin Apps ===
'''References'''<br />* [http://wwwPlugins are "mini apps" that live inside the Amahi platform and thus little interface need to be developed for them.openmediavaultThey are familiar and provide easy, focused value to the user.org/ OpenMediaVault]Ideas:
==Greyhole UI==* Support for automatic issuing/renewal and installation of [https://letsencrypt.org/ Let's Encrypt] certificates in the platform, for external access across the internet'''Description'''* [https://bugs.amahi.org/issues/1361 Share space usage]: Using [http://d3js.org D3.js] (for example) to visualize things internal to the system, like finding out the disk space used by shares, disk usage over time, etc.* [https://bugs.amahi.org/issues/1480 Wake-on-LAN (WOL)]: The Amahi [http://www.amahi.org/apps/wake-on-lan-server Wake-On-LAN Server] app currently provides this capability.* [https://bugs.amahi.org/issues/1481 Virus Scan Shares]* [https://bugs.amahi.org/issues/1489 Netboot Settings/Configuration]* [https://bugs.amahi.org/issues/1487 Mail Relay] (i.e. using Gmail or ISP)* [https://bugs.amahi.org/issues/1459 Convert app] [https://www.amahi.org/apps/Amahi-energy-saver Amahi Energy Saver] to a plugin.* View log files in web browser ([https://github.com/tobi/clarity Clarity using RoR])* Ability to update default SSL certificates (used by [https://www.amahi.org/apps/openvpn OpenVPN], [https://www.amahi.org/apps/amahi-anywhere Amahi Anywhere], etc).* AmahiTunes revival* RAID (SW, MDADM?) support* [https://bugs.amahi.org/issues/1458 SMART Disk] monitoring
Greyhole is an application that uses Samba to create a storage pool of all your available hard drives (whatever their size, however they're connected), and allows you to create redundant copies of the files you store, in order to prevent data loss when part of your hardware fails.
'''Objective'''
Create and amahi plugin that provides an UI that allows for the management of the greyhole pool.'''Mentors''': Rod, Carlos
'''Expected result'''=== [https://www.amahi.org/apps/disk-wizard Disk Wizard] ===
'''Description''': Expanding the storage capacity is an important feature of Amahi. The plugin DW is a critical part. However, it's not as stable as it should allow an administrator user to:add/remove disks to/from the poolbe.*change the number of copies for individual file/directory*invoke various gh commands*view It should detect more partition types and monitor log files*gui to visualize data distributionhandle everything gracefully, even when it can't act upon certain configurations.
'''Objective''': Stability improvements and especially thoroughly testing this plugin for disk/partition management.
'''Skills Required'''* RoR, System programing: Low level system scripting
'''MentorMentors''': Rod, Carlos
==User Onboarding=='''DescriptionReferences''':* [https://bugs.amahi.org/issues/580 Track the disk wizard]* [[New Disk Wizard]] ideas page* [http://www.openmediavault.org/ OpenMediaVault] does have a nice wizard that people like
Improved workflow for users to come up with their HDA running
'''Objective'''Happier users=== Amahi 12 ===
'''Expected resultDescription'''Have an automated unit test. It should test the current network settings against the expected settings.In case of inconsistencies it should offer the user solutions with very little interaction: [[Amahi 12]] is our next release.
'''Skills RequiredObjective'''* : Work closely with the core team to define the features and functionality that we need to implement to get Amahi released. This project is about working on RoRand the Amahi platform core. Some of the core technology will need to be upgraded, scriptinglike Rails 5, netflow capturelatest Phusion Passenger, dhcping scriptingpossibly replace MySQL for the platform, create a native API to the platform that can be used by other apps, like mobile apps. Other ideas include beefing up security and provide support for Amahi hosting on the cloud. Features:
'''Mentor'''* make platform even more modular and cleaner (at the moment we still have some things that really belong in plugins but still are in controllers/views of the main app)* possibly using a new metal layer instead of passenger - especially ones that do not take a long time to reload, could be puma, i also like thin, maybe others* Danielbetter initialization ... like a more standard (wordpress-like) initialization wizard (initially there are no users, Carloswe need to create an admin user and perhaps ask a few questions and integrate with amahi.org)* Implement sharing of folders among the friend servers.
==Backup app data/settings==
'''Description'''
An important drawback of Amahi is the inability to backup the installed applications and their user data'''Skills Required''': RoR, ruby, JS, CSS, HTML5, Bootstrap
'''ObjectiveMentors''': Carlos, Rod, Sukhbir
Create an '''Reference''': [https://github.com/amahi plugin that will allow backup and restore of the user data for apps installed from the AppStore/platform Amahi Platform repo]
'''Expected result'''== Android Mobile App==
The plugin should allow an administrator to backup any application data either on an external media or in the cloud(e.g.: DropboxOur mobile apps have streaming, Google Drive, etc).The restore process should check if the application is installed on the HDA browsing and sharing and if not it should be automatically installed from the AppStore before the user data is restored's a great topic.
This year we'''Skills Required'''* System scriptingre going to try emphasizing the Android app a little more.
'''Mentor'''
* Rod
==Parental Controls=Android App Improvements==='''Description'''
'''ObjectiveDescription''': Amahi Android offers the ability to stream your HDA over your Android phone and Android TV, support for Chromecast and auto-upload of images to HDA. The next step is to complete the following objectives:
Develop and plugin that will allow an administrator user to control the traffic for specific devices inside the network'''Objectives''':
* Android TV Revamp: The Android TV app is outdated at the moment and doesn't follow the latest design principles of Android. We have to redesign the app so that Amahi is accessible on Android TV again. Further, we have to implement the PlayerAdapter in Android TV to support previews.* Support for Dagger 2: The current app is written using Dagger 1. We have to port the code to Dagger 2 so that we can use the latest libraries which are dependent on it.* Support for NAU: Complete the app with support for Non-Admin User which currently exists on the server-side only. Ref: https://docs.google.com/presentation/d/1jZAdXpSGQRJ6xN2WCzqkiPxQPUW2VHsAnpENZKbT2z0* UI Improvements and UI Testing: Adding an Expresso based automated UI testing protocol.* Improve Background Service: Improve the app for uploading media on the HDA when the app isn''Expected result'''t present in the foreground* Phone Auto-Backup: Develop a module that does an Auto backup of the phone to the HDA over Local connection (reference: Helium)* Friending Feature: Implement the sharing of folders or shares with other servers. https://docs.google.com/document/d/14JsH9-aZrE3Z-35Oo38IY1-3Nd5BJiR_G0DshhjKSM4/* VPN: Add support for VPN proxy so that the user can access the HDA from the phone over a VPN proxy tunnel.
The '''Skills Required''': Java, Android framework '''Mentors''': Carlos, Chirag '''Reference''': [https://github.com/amahi/android Amahi Android Github repo] == Apps== Innovative app or app packaging and app-related projects. ===Improved VPN Security=== '''Description''': Improve the security of our OpenVPN and IPSec VPN apps. Examples are allowing users to generate their own certificates, identify weak spots and strengthen them. '''Objective''': For the example of generating their own certificates, build a wizard to allow users to create and manage their certificates. Another goal would be to provide logging of VPN connections, so that the user can see the activity on their VPN. '''Skills Required''': keen sense of security settings, certificates '''Mentors''': Rod, Carlos ===Caching Server=== '''Description''': a caching proxy to save on bandwidth '''Objective''': Develop a plugin that will allow an administrator user to control the traffic for specific devices inside the network. This app (or possibly a plugin) should display all the connected device as well as provide the ability to search by name/MAC address. For a selected device the administrator should:
*Limit access between certain time intervals
*Limit bandwidth
'''Skills Required''': system configuration and scripting
'''MentorMentors''': Carlos, Rod
===Create UI and package it for RSnapshot===
==Mobile App Awesomization (iOS)=='''Description''': Make a UI for rsnapshot
'''Objective''': [http://www.rsnapshot.org/ RSnapshot] is a great application to backup local data, making efficient use of storage as well as CPU resources and can handle a lot of data. A one-click app that includes a UI to set up and manage RSnapshot backups. Also, possibly backup to GDrive, S3, other cloud solutions
Take the iOS app to a whole new level of usability and popularity by adding really useful features'''Skills Required''': RoR, like*algorithmically detect image-heavy folders on the fly and offer to display them as a gallery view*similarly with on-the-fly music folders*dynamic search*SPDY support for all remote accesses (+1 for local)*support for webapp browsing*folder sharing*local user support*adding support for GDrive, Dropboxsystem programming
'''Mentor''': Carlos, Rod, Sukhbir
'''Expected resultReferences'''* [http://sourceforge.net/projects/rsnapshotbackup/ rsnapshot-backup-php]* [http://dobrev.ws/projects/webrsnapshot Webrsnapshot]
The mobile app will become really polished and fast, as well as a pleasure to use.==Installer==
'''Skills Required'''===Improved Installation===
'''MentorDescription''': Improved installation experience for users.
==Mobile App Implementation (Android)=='''DescriptionObjective''': Configuration and installation of Amahi can be painful for some percentage of users. Many of them do not know much or care for Linux. We want to make the installation as smooth as possible not just for them, but for more even more regular (non-techy) users. Ubuntu has some challenges of its own to make it work without dropping the users to the command line.* Create a new [https://fedoraproject.org/wiki/Anaconda Anaconda] node for Amahi configuration* Similarly for Ubuntu* Make images that enable booting from USB devices "out of the box"* Detect sub-optimal configurations of disk partitions and provide feedback to the user* Measure and analyze how users get tripped on installation and create ways to tackle these issues, bringing installation issues down
'''Objective'''
We have great demand for an Android app thanks to the popularity of our iOS appIdea: use [https://github. Our users want us to make an Amahi Android app com/diafygi/webrtc-ips this package ] to support login, browsing and streaming of Amahi servershelp improve installation networking issues.
'''Expected resultSkills Required''': Python, Linux boot process internals, creating ISO images
An Android app that can be on par or better than the iOS app'''Mentors''': Carlos, with mobile streaming, downloading files and sharing them.Rod
'''Skills Required'''==Amahi Anywhere==
'''Mentor'''The mobile apps use API endpoints provided by Amahi Anywhere for browsing, downloading and streaming files and more.
==Create UI and package it for RSnapshot=='''DescriptionReferences''':* [https://www.amahi.org/apps/amahi-anywhere Amahi Anywhere App]* [https://github.com/amahi/amahi-anywhere-specs Amahi Anywhere Specs]
'''Objective'''===Improvements in AA File Server===
RSnapshot is a great application '''Description''': Amahi Anywhere File Server exposes HDA files and directories via REST APIs and also allows to backup local data, making efficient use of storage as well as CPU resources and can handle a lot of data.upload new files
'''Expected resultObjective''': Following features can be implemented:
A one* API to access platform apps over remote via proxy* Better logging ([https://github.com/amahi/amahi-anywhere-click app that includes a UI fs/issues/4 Issue #4])* Simplistic dashboard to view some metrics like number of users connected, access logs for each user, system health etc.* API to set up fetch metadata (duration, codec, album art image, title, artist name, album name, year etc.) for audio / video files* Create and cache low resolution thumbnail for image files for faster loading and manage RSnapshot backups.enhanced experience
'''Skills Required'''
'''MentorSkills Required''': GoLang, REST API Understanding
==Data nodes that integrate with main amahi server=='''DescriptionMentors''': Carlos, Chirag
'''ObjectiveReference''': [https://github.com/amahi/amahi-anywhere-fs/ Amahi Anywhere FS Github repo]
Create a system to create data nodes that integrate with the amahi API as well as auto mount as NFS or SMB shares to allow the usage of applications through locally mounted shares (such as gallery, subsonic etc). This would allow you to connect Windows / Linux computers as data nodes. Perhaps an installable agent?===Improvements in External Proxy===
'''Expected resultDescription''': External proxy provides API endpoints for users to remotely access Amahi Anywhere File Server
An installer that integrates with amahi (a stripped down version of Amahi?) and a management pane in the main amahi server that allows you to add a server by IP or DNS name.'''Objective''': Following features can be implemented:
'''Skills Required'''* Cache implementation for chunks of files passing frequently through proxy to speed up response and save bandwidth* Dashboard to view metrics on both connected mobile and Amahi Anywhere FS clients* Ability to ban a client
'''Mentor'''
==Ubuntu 12.04 Amahi Development=='''DescriptionSkills Required''': GoLang
'''ObjectiveMentors''': Carlos, Chirag
Further =Other Ideas= * Add features to our popular mobile apps: Offer to display image-heavy folders and shares within a "gallery" or collection view, add the ability to navigate and stream shares containing music in a streamlined way, Dynamic search, SPDY support, for both remote and local queries, support for accessing HDA web applications within Amahi for iOS, share folders and files from your HDA to other apps or users, support for HDA user permissions (share & web app restrictions, etc.). Mentors available: Carlos* PHP API: make a native PHP SDK for the Amahi platform, so that PHP apps (we have a lot of them) can more easy be integrated * Integrate a mail server as an app. Identify any settings or configuration that need to be implemented in the platform* Router integration, UPNP, direct control* Port AES (Amahi Energy Server) to the latest Amahi* Integration of LDAP as a back-end management system, calendaring* Feature development (examples):* Calendaring, and integrated contact manager application. Possible options: 1) ownCloud based or 2) Apache carddav* For the more design-oriented, build mobile theme(s)* Documentation or screencasts/tutorials* Use sandboxing and containers to improve app stability, updating and more* Improve installation and user onboarding (OOBE)* Better upgrades with backup of apps, settings, etc.* Create a backup and restore function for the Amahi Server (Idea is to backup the of the setting like the shares, paths and Fixed IP address and Mac Address, remove all the data drives) reinstall the OS or Upgrade and then put the data dives back in and then restore all the setting)* make the Amahi front end webpage more mobile-friendly* Add Icon for the install app pages and have more screenshots* make it easier to run multi servers on the amahi platform one network* DHCP page a button to add a device to Fixed IP address will be able to install change the same applications fix IP address and have the same features as Name or just us the default one* update Button on installed apps this will only work on apps that are updateable, it will run an update script from when the ubuntu based version.was created, lots of apps nowadays are updated able and would save time uninstalled and reinstalling* Create a page or tab on Amahi front end to be able to add docker container apps select icon and name and address:port
'''Expected result'''
A new install CD or ruby package that allows you Plus, of course we are open to add amahi functionality to Ubuntu 12suggestions.04 or Ubuntu 14Open a dialog.04 (if it is released We're happy to discuss and LTS)determine a suitable project.
'''Skills Required'''Amahi is a platform that will support the deployment of other open source applications. If you are interested in the integration of applications in your area of interest, just contact us with suggestions.
'''Mentor'''=Mentors=
==Make Amahi This is a rolling distribution==list of '''Descriptioncommitted'''mentors. If you are interested in mentoring, let us know via IRC (mention the nicks below):
'''Objective'''* Carlos Puchol (cpg, GSoC admin): team lead for Amahi, experience in RoR, Go, Ruby, RoR, system scripting/development, app packaging, C, C++* Bogdan Mitrea (megabitdragon, GSoC admin): Android, Java, app packaging, system programming,C , C++, community lead* Rod Runyon (bigfoot65): app lead for Amahi, system programming, app packaging, reliability, documentation, support* Chirag Maheshwari, former GSoC student for Amahi* Kumar Shashwat, former GSoC student for Amahi* Sukhbir Singh, former GSoC student for Amahi* Dipankar B. Amahi collaborator* Nitin V., Amahi collaborator
Being able to upgrade amahi versions without having to upgrade OSs is very appealing and a huge win.
'''Expected result'''Reference: [https://google.github.io/gsocguides/mentor/ GSoC mentoring page].
Make Amahi into a rolling distribution.= Prior Years =
'''Skills Required'''Amahi participated in GSOC in 2020, 2019, 2018, [[Google Summer of Code 2017]] 2016, and [[Google Summer of Code 2014]]
'''Mentor'''== Prior Ideas (NOT for 2021) ==
=== iOS App Improvements ===
'''Description''': Amahi iOS app supports all basic functionalities including browsing files on HDA, streaming audio/video, offline file access but still lacks a lot of features compared to its Android counterpart
=Hard=* Add support for UPnP control '''Objective''': Addition of home routers from within the setup pages, e.g. to easily new features and dynamically control settings like DHCP server enable/disable, port forwarding, etc.* Add support for Ubuntu or, improvements in general, debianpre-based distributions* Add support for an Android based distribution * Enhance REST API existing ones in iOS app in swift to support management from other interfaces (eg. Android, iPhone)* Build Android at least match or iPhone interface to control home server* Integrate one of surpass the more complex applications, such as** MythTV back-end** FUPPES UPnP server (or other UPnP/DLNA server, eg. uShare, mediatomb)** firewall (Shorewall, moonwall, ...) ** Asterisk** OpenPBX* Integration of LDAP as a back-end management system* Feature development (examples):** Easily change domain/DHCP settings managed by Amahi** Use external and internal domain (internet/intranet)** Change share servers to use a plugin system to allow each share to select which server they use** Browseable selection of files and paths in dashboard** Ability to add/mount disks via browser interface** Seamlessly add drives as an option for share pointsAndroid app
=Medium='''Things to be implemented''': * Secondary user login* Chromecast support* Integrate a mail serverMetadata display* Enhance the theme engine to handle mainstream templates directly or with minimal configuration (e.g. Drupal, Wordpress, or others)Continuous music play* Replace BIND as DNS server by a more dynamic, reconfigurable DNS serverUpload and delete functionality* Build an integrated contact manager applicationThumbnail previews
=Easy=
* Improve the theme engine to handle more sophisticated themes
* For the more design-oriented, build new and exciting themes
Plus'''Skills Required''': iOS programming, of course we are open to suggestions. Open a dialog. We're happy to discuss and determine a suitable project.Swift
For other ideas'''Mentors''': Carlos, review our page on how to [[Contribute]]. Then explore our [http://forums.amahi.org/viewforum.php?f=15 suggestions forum] and our new [http://bugs.amahi.org/ bug tracker] (features suggested). Chirag
'''Reference''': [https://github.com/amahi/ios Amahi is a platform that will support the deployment of other open source applications. If you are interested in the integration of applications in your area of interest, just contact us with suggestions.iOS app repo]
== Reference ==
* [https://www.google-melange.com/gsoc/homepage/google/gsoc2014 GSOC 2014]
* [http://drupal.org/node/59037 Drupal]
* [http://forge.mysql.com/wiki/SummerOfCode/ApplicationTemplate MySQL]
* [http://techbase.kde.org/Projects/Summer_of_Code/2009/Ideas KDE Ideas]
