Are you a GSOC student or mentor? Have questions? Contact us via IRC on [http://talk.amahi.org #amahi on irc.freenode.net] or on the amahi-devel [[mailing list]].= About Amahi=
If you are interested We're looking for students with skills in being a mentorthese areas: current technologies like RoR, ruby, we have a 6 great mentors python, PHP, as well as of todaynext generation technologies, but like Go (we're very welcoming of mode ideas and more mentors!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.
If you are '''We're also looking for hardware projects! Creating a student, come talk to us about these ideas below Raspberry Pi-style device with great I/O that can run Amahi smoothly is a long-tem goal for possible projectsAmahi! Don't forget that these are subject to suggestions, extensions or adaptations. Even new ideas will be considered. Some of these ideas are more mature and concrete than others.''
The Amahi started of a need to keep a personal/home cloud server, keep all my family'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. 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/hda-ctl installer] to help the user bring bring Amahi up in their system* A [https://github.com/amahi/platform platform], which is a web app that the user uses to manage their server, add 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 [http://www.amahi.org/ios iOS]. 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. = What to do (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 '''most important thingnot''' blindly try to build things without understanding what Amahi is and what it does* do '''not''' just submit a pull request or issue a bug without really knowing what you are up to find an * do '''not'''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=sf_link introduce yourself with this form], so that we know your background and interests. If you have questions about Amahi or just want to interact, you can contact us via IRC on [http://talk.amahi.org #amahi on irc.freenode.net] (fairly active) or on the amahi-devel [[mailing list]] (not as active). Don'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 '''enjoy''', using a programming language environment that you know or that you are willing to learnquickly, so read below or ask questions. If you are interested in being a mentor, we have a few great mentors as of today, but we're very welcoming of more ideas and more mentors! See the [[#Mentors|mentors]] below. Looking for ideas to mentor, see the [[#Other Ideas|other ideas]] below.
=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 UX ==we'd love to hear from you!
===Better Theming=Platform ==
'''Description''': Our theming is pretty good, however, it's very customized.===Plugin Apps ===
'''Objective''': Happier usersPlugins are "mini apps" that live inside the Amahi platform and thus little interface need to be developed for them. The idea is They are familiar and provide easy, focused value to have an automated configuration. 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. Ideas:
* Support for automatic issuing/renewal and installation of [https://letsencrypt.org/ Let'''Skills Required'''s Encrypt] certificates in the platform, for external access across the internet* [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], scripting[https://www.amahi.org/apps/amahi-anywhere Amahi Anywhere], netflow captureetc).* AmahiTunes revival* RAID (SW, dhcping scriptingMDADM?) support* [https://bugs.amahi.org/issues/1458 SMART Disk] monitoring
'''Mentors''': Daniel, Carlos
==Installer==
===Improved Installation==='''Mentors''': Rod, Carlos
'''Description'''=== [https: Improved installation, e//www.gamahi. new Anaconda "node" or some similar thing for Ubuntuorg/apps/disk-wizard Disk Wizard] ===
'''ObjectiveDescription''': Expanding the storage capacity is an important feature of Amahi. The DW is a critical part. However, it's not as stable as it should be. It should detect more partition types and handle everything gracefully, even when it can't act upon certain configurations.
'''Skills RequiredObjective''': PythonStability improvements and especially thoroughly testing this plugin for disk/partition management.
'''MentorsSkills Required''': Daniel, Jesse, CarlosLow level system scripting
===User Onboarding==='''Mentors''': Rod, Carlos '''References''':* [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
'''Description''': Improved workflow for users to come up with their HDA running
'''Objective''': Happier users. The idea is to have an automated configuration. 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 ===
'''Skills RequiredDescription''': RoR, scripting, netflow capture, dhcping scripting[[Amahi 12]] is our next release.
'''MentorsObjective''': DanielWork 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 RoR and the Amahi platform core. Some of the core technology will need to be upgraded, Carloslike Rails 5, latest Phusion Passenger, possibly 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:
== Platform ==* 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* better initialization ... like a more standard (wordpress-like) initialization wizard (initially there are no users, we 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.
===Plugin System===
'''DescriptionSkills Required''': Make the ability to create and install Amahi plugins easy and enable the creation of those plugins for a variety of purposesRoR, like SMART monitoringruby, system stuff (network scanningJS, etc.) and the two examples below for the disk wizard and the Greyhole UICSS, among other ideas.HTML5, Bootstrap
'''ObjectiveMentors''': Create an amahi plugin systemCarlos, where PHPRod, Python, Node, and other modern webapps can be easily integrated. We can currently do this with some RoR engines, but the mechanism is not robust enough. The plugins system should allow modern web-based apps 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 AmahiSukhbir
'''Skills RequiredReference''': RoR[https://github.com/amahi/platform Amahi Platform repo]
'''Mentors''': Carlos, Rod== Android Mobile App==
===Disk Wizard===Our mobile apps have streaming, browsing and sharing and it's a great topic.
This year we'''Description''': Expanding the storage capacity is an important feature of Amahi but as of now it requires advanced (e.g. command line) skills. We want easy disk/partition onboarding.Also add re going to try emphasizing the ability to be asked to mount USB drives as Android app a share when they're connected & connect external shares from for example a NAS with the plugin system using that wizardlittle more.
'''Objective''': Create an amahi plugin that will streamline this process by providing a UI for disk management. The plugin should detect if a new disk was added and it should provide a wizard to create partitions and format with the desired file system
'''Skills Required''': Low level system scripting===Android App Improvements===
'''MentorsDescription''': DagAmahi Android offers the ability to stream your HDA over your Android phone and Android TV, Bogdansupport for Chromecast and auto-upload of images to HDA. The next step is to complete the following objectives:
'''ReferencesObjectives''':* [http://www.openmediavault.org/ OpenMediaVault] does have a nice wizard that people like
===Greyhole * 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'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.
'''Description''': 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. The purpose of this plugin is to provide a UI and the necessary tools under the UI to make starting and managing a Greyhole UI possible and nice to understand for regular humans.
'''ObjectiveSkills Required''': Create and amahi plugin that provides an UI that allows for the management of the greyhole pool. The plugin should allow an administrator user to:add/remove disks to/from the pool.* change the number of copies for individual file/directory* invoke various gh commands* view and monitor log files* gui to visualize data distributionJava, Android framework
'''Skills RequiredMentors''': RoRCarlos, System programingChirag
'''MentorsReference''': Carlos, Rod[https://github.com/amahi/android Amahi Android Github repo]
===Backup app data/settings=Apps==
'''Description''': An drawback of Amahi is that it's hard to backup the installed applications Innovative app or app packaging and their user dataapp-related projects.
'''Objective''': The plugin should allow an administrator to backup any application data either on an external media or in the cloud(e.g.: Dropbox, Google Drive, etc).The restore process should check if the application is installed on the HDA and if not it should be automatically installed from the AppStore before the user data is restored.*Create an amahi plugin that will allow backup and restore of the user data for apps installed from the AppStore*Centralising app data/configs - link them to app folder instead.*"Destructive" update awareness*Ability to list, outline data directories for backups/upgrade check===Improved VPN Security===
'''Skills RequiredDescription''': System scriptingImprove the security of our OpenVPN and IPSec VPN apps. Examples are allowing users to generate their own certificates, identify weak spots and strengthen them.
'''MentorObjective''': RodFor the example of generating their own certificates, Danielbuild 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.
== Apps=='''Skills Required''': keen sense of security settings, certificates
Innovative app packaging or app related projects.'''Mentors''': Rod, Carlos
===Caching Server===
'''Description''': a caching proxy to save on bandwidth
'''Objective''': Develop and 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
*Block certain websites (either on an individual basis or read them from a file)
*Limit traffic
'''Skills Required''': system configuration and scripting
'''Mentors''": Daniel, Jesse ===Network Groups=== '''Description''': Develop a plugin to allow network device grouping. This will be the framework for future plugins. '''Objective''': Allow an administrator to group network devices in groups with different permissions. Limit the user access to certain apps based on the group settings. '''Skills Required''': RoR, system programming '''Mentors''': JesseCarlos, DanielRod
===Create UI and package it for RSnapshot===
'''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
'''Skills Required''': RoR, system programming,
'''Mentor''': Carlos, Rod, DagSukhbir
'''References'''
* [http://dobrev.ws/projects/webrsnapshot Webrsnapshot]
===Package VoIP and/or PBX system=Installer==
'''Description''':===Improved Installation===
'''Objective''': '''Skills RequiredDescription''': Improved installation experience for users.
'''MentorsObjective''': 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
==Mobile==
===Mobile App Awesomization (iOS)===Idea: use [https://github.com/diafygi/webrtc-ips this package ] to help improve installation networking issues.
'''DescriptionSkills Required''': Take the iOS app to a whole new level of usability and popularity. The goal is to make the mobile really polished and fastPython, as well as a pleasure to use.Linux boot process internals, creating ISO images
'''ObjectiveMentors''': Add really useful features to the appCarlos, 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, Dropbox*Mobile user onboarding, and HDA setup assistanceRod
==Amahi Anywhere==
'''Skills Required''': Objective-C/CocoaThe mobile apps use API endpoints provided by Amahi Anywhere for browsing, downloading and streaming files and more.
'''MentorsReferences''': Jesse, Carlos* [https://www.amahi.org/apps/amahi-anywhere Amahi Anywhere App]* [https://github.com/amahi/amahi-anywhere-specs Amahi Anywhere Specs]
===Mobile App Implementation (Android)Improvements in AA File Server===
'''Description''': We have great demand for an Android app thanks to the popularity of our iOS app. Our users want us to make an Amahi Android app Anywhere File Server exposes HDA files and directories via REST APIs and also allows to support login, browsing and streaming of Amahi servers.upload new files
'''Objective''': An Android app that is on par or better than the iOS app, with mobile streaming, downloading files and sharing them.Following features can be implemented:
'''Skills Required'''* API to access platform apps over remote via proxy* Better logging ([https: Java//github.com/amahi/amahi-anywhere-fs/issues/4 Issue #4])* Simplistic dashboard to view some metrics like number of users connected, Android Stackaccess logs for each user, REST servicessystem health etc.* API to fetch metadata (duration, jsoncodec, 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 enhanced experience
'''Mentor''': Jesse, Carlos, Bogdan
== Networking =='''Skills Required''': GoLang, REST API Understanding
===Clustering Amahi Servers==='''Mentors''': Carlos, Chirag
'''DescriptionReference''': 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)[https://github. This would allow you to connect Windows com/amahi/amahi-anywhere-fs/ Linux computers as data nodes. Perhaps an installable agent?Amahi Anywhere FS Github repo]
'''Objective''': An installer that integrates with Amahi (a stripped down version of Amahi?) and a management pane ===Improvements in the main amahi server that allows you to add a server by IP or DNS name.External Proxy===
'''Skills RequiredDescription''': External proxy provides API endpoints for users to remotely access Amahi Anywhere File Server
'''MentorsObjective''': Following features can be implemented:
===Rolling Distribution===* 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
'''Description''': Make Amahi a rolling distribution
'''ObjectiveSkills Required''': Being able to upgrade Amahi versions without having to upgrade OSs is very appealing and a huge win.GoLang
Make Amahi into a rolling distribution.'''Mentors''': Carlos, Chirag
'''Skills Required'''=Other Ideas=
'''Mentor'''* 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 one network* DHCP page a button to add a device to Fixed IP address will be able to change the fix IP address and the 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 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
==Reliability==
===Improve App Stability==='''Description''Plus, of course we are open to suggestions. Open a dialog. We': Use containers re happy to improve app stabilitydiscuss and determine a suitable project.
'''Objective''': Use containers like Docker for better app installs an interactionsAmahi is a platform that will support the deployment of other open source applications. Better app packagingIf you are interested in the integration of applications in your area of interest, just contact us with suggestions.
'''Skills Required'''=Mentors=
This is a list of '''Mentor:committed'''mentors. If you are interested in mentoring, let us know via IRC (mention the nicks below): Carlos
===App Testing===* 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
'''Description''': App reliability is critical for Amahi.
'''Objective'''Reference: Bring up a CI server (aka "the grinder") up to speed[https://google.github. Goal is app reliability being 100%io/gsocguides/mentor/ GSoC mentoring page]. We have
'''Skills Required''': RoR= Prior Years =
'''Mentors''': CarlosAmahi participated in GSOC in 2020, 2019, 2018, [[Google Summer of Code 2017]] 2016, and [[Google Summer of Code 2014]]
===Ubuntu 14.04=Prior Ideas (NOT for 2021) ==
'''Description'''=== iOS App Improvements ===
'''ObjectiveDescription''': 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
Further development on the amahi platform to be able '''Objective''': Addition of new features and improvements in pre-existing ones in iOS app in swift to install the same applications and have the same features as at least match or surpass the ubuntu based version.Android app
'''Expected resultThings to be implemented''': * Secondary user login* Chromecast support* Metadata display* Continuous music play* Upload and delete functionality* Thumbnail previews
A new install CD or ruby package that allows you to add amahi functionality to Ubuntu 12.04 or Ubuntu 14.04 (if it is released and LTS)
'''Skills Required''': iOS programming, Swift
'''MentorMentors''': Carlos, Chirag
=Other Ideas= * Integrate a mail server* Router integration, UPNP, direct control* Port AES (Amahi Energy Server) to Amahi 7* Integration of LDAP as a back-end management system, calendaring* Feature development (examples)'''Reference''':* Calendaring, and integrated contact manager application[https: possible work-around - owncloud* For the more design-oriented, build mobile theme(s) Plus, of course we are open to suggestions. Open a dialog. We're happy to discuss and determine a suitable project//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]
