4,146
edits
Changes
From Amahi Wiki
Google Summer of Code 2017 (view source)
Revision as of 09:12, 23 January 2018
, 09:12, 23 January 2018Created page with " '''Amahi has been accepted for GSoC 2017!''' Students: See the ideas below for GSoC 2017! = Students = [https://summerofcode.withgoogle.com/archive/2017/organizations/6..."
'''Amahi has been accepted for GSoC 2017!'''
Students:
See the ideas below for GSoC 2017!
= Students =
[https://summerofcode.withgoogle.com/archive/2017/organizations/6673844588773376/ Amahi 2017 Projects]
Kumar Shashwat: Adding new functionalities to the Android app: Android TV, non-admin users, etc.
Chirag Maheshwari: Android app support for Chromecast, advanced features and bring more functionality to the app.
Vikas Yadav: Dockerize Amahi Apps. Improve the app installation process using docker.
= About Amahi=
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.
'''We're also looking for hardware projects! Creating a small RasPi device that runs Amahi smoothly is a long-tem goal for Amahi!'''
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 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.
= Introduce yourself, interact with the community =
First, please [https://docs.google.com/forms/d/e/1FAIpQLSdATld5a5I0_ImhMn4LqV5kUChP-oTeNjQSqEMDCVdMjNeKLg/viewform?usp=send_form 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 environment that you know or that you are willing to learn quickly, 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 we'd love to hear from you!
==Mobile==
Mobile is a great topic and there are a lot of opportunities here within Amahi.
===Android App Improvements===
'''Description''': Add functionality to the Android app
'''Objectives''':
* Updates: update material design, update deprecated (or soon to be) calls, provide backwards compatibility
* Add Chromecast support for media playback (videos, audio and pictures)
* Make the application compatible with Android TV
* Secondary user login for the app
* Add upload functionality, e.g. automatically upload photos to your HDA
* Auto backup your phone to your HDA (reference: "Helium")
* Thumbnail previews (Amahi [https://bugs.amahi.org/issues/2191 Bug # 2191])
'''Skills Required''': Java, Android framework
'''Mentors''': Carlos, Bogdan
'''Reference''': [https://github.com/amahi/android Amahi Android Github repo]
=== iOS App Improvements ===
'''Description''': Add functionality in the iOS app
'''Objective''': enhance the iOS app to at least match or surpass the Android app
'''Things to be implemented''':
* Sharing of files
* Music metadata display
* Continuous music play
* Secondary user login
* Upload functionality
* Thumbnail previews (Amahi [https://bugs.amahi.org/issues/2191 Bug # 2191])
'''Skills Required''': iOS programming
'''Mentors''': Carlos, Rod
'''Reference''': [https://www.amahi.org/ios Amahi iOS app]
== Platform ==
===Plugin Apps ===
Plugins are "mini apps" that live inside the Amahi platform and thus little interface need to be developed for them. They are familiar and provide easy, focused value to the user. Ideas:
* [https://bugs.amahi.org/issues/1361 Share disk space]: Using [http://d3js.org D3.js] 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/1595 Browser video player]: Using something like [https://bugs.amahi.org/issues/1595 broadway.js] for doing a video player on just a browser
* [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/1458 SMART Disk] monitoring
* [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 integration
* RAID (SW, MDADM?) support
'''Mentors''': Rod, Carlos
=== [https://www.amahi.org/apps/disk-wizard Disk Wizard] ===
'''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 the ability to be asked to mount USB drives as a share when they're connected & connect external shares from for example a NAS with the plugin system using that wizard.
'''Objective''': Finish implementing and especially thoroughly testing an Amahi plugin that will streamline the 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
'''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
=== Amahi 10 ===
'''Description''': Amahi 10 is what's next. This is the time to come up with exciting features and ideas that we should put and the GSOC timeline is a perfect match!
'''Objective''': 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 RoR and the Amahi platform core. Some of the core technology will need to be upgraded, like Rails 4, latest Phusion Passenger, possibly replace MySQL for the platform and use sqlite, 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:
* fully convert the front-end to bootstrap and make sure we can install bootstrap themes and have a consistent and responsive look and behavior
* make it 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)
'''Skills Required''': RoR, ruby, JS, CSS, HTML5, Bootstrap
'''Mentors''': Carlos, Rod
== 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 and 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''': Carlos, Rod
===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
'''References'''
* [http://sourceforge.net/projects/rsnapshotbackup/ rsnapshot-backup-php]
* [http://dobrev.ws/projects/webrsnapshot Webrsnapshot]
==Installer==
===Improved Installation===
'''Description''': Improved installation experience for users.
'''Objective''': 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
Idea: use [https://github.com/diafygi/webrtc-ips this package ] to help improve installation networking issues.
'''Skills Required''': Python, Linux boot process internals, creating ISO images
'''Mentors''': Carlos, Rod
== Networking ==
=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.
Plus, of course we are open to suggestions. Open a dialog. We're happy to discuss and determine a suitable project.
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.
=Mentors=
This is a list of '''committed''' mentors. If you are interested in mentoring, let us know via IRC (mention the nicks below):
* Carlos Puchol (cpg, PST, GSOC admin): team lead for Amahi, experience in RoR, Go, Ruby, RoR, system scripting/development, app packaging, C, C++
* Bogdan Mitrea (megabitdragon, CST, GSOC admin): Android, Java, app packaging, system programming,C , C++, community lead
* Rod Runyon (bigfoot65, CST): app lead for Amahi, system programming, app packaging, reliability, documentation, support
Reference: [http://en.flossmanuals.net/GSoCMentoring/ GSOC mentoring page].
= 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]
