Changes

From Amahi Wiki
Jump to: navigation, search
3,022 bytes removed ,  18:55, 20 February 2021
Updated Android App Improvements section.
= About Amahi=
We'''Amahi is applying re looking for hosting 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 GSoC 2016!''' See the ideas below streaming to our mobile apps), [https://nodejs.org/ Node.js], [https://github.com/amahi/spdy HTTP/2], javascript frameworks for GSoC 2016! = About Amahi=user interaction, visualization or server services, etc.
'''We're also looking for students hardware projects! Creating a Raspberry Pi-style device 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), Node.js, [https://github.comgreat I/amahi/spdy SPDY], javascript frameworks O that can run Amahi smoothly is a long-tem goal for user interaction, visualization or server services, etc.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 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.
You can see the [[Google Summer of Code 2014]] page for projects that took place in 2014.= What to do (and NOT do) first =
= Introduce YourselfLet's talk about what NOT to do first, Interact with the Community =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 '''not''' 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* 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
If you are you a GSoC studentBUT First, we will ask that you Introduce yourself, interact with the community, so please [https://docs.google.com/a/puchol.com/forms/d/1k4MQbhQtSCxfP_con95MnjxLv3GeuJifs9jjNBd3E84e/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 these we are subject 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 learn quickly, so read below or ask questions.
If you are interested in being a mentor, we have five 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.
 
Some of the most successful proposals have been completely new ideas submitted by students, so if you don’t see a project on the ideas above that appeals to you, don’t be afraid to suggest a new idea!
=List of Project Ideas=
== Platform ==
 
===Docker Sandboxing for Apps===
 
'''Description''': Use containers to improve app stability, updating and more
 
'''Objective''': Some apps may be more suitably installed inside a container because they may be too disruptive in a system. Can we you use popular sandboxing environments to contain apps that want to take over things, like Zimbra, or some PBX/VoIP systems, etc.
 
'''Skills Required''': [http://docker.io Docker], Vagrant (for testing), ruby, bash, [http://pdos.csail.mit.edu/mbox/ Mbox]
 
'''Mentor:''': Carlos, Bogdan
===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:
* Support for automatic issuing/renewal and installation of [https://letsencrypt.org/ Let's Encrypt] certificates in the platform, for external access across the internet* [https://bugs.amahi.org/issues/1361 Share disk spaceusage]: 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/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)
* 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 integrationrevival
* RAID (SW, MDADM?) support
* [https://bugs.amahi.org/issues/1458 SMART Disk] monitoring
 
'''Mentors''': Rod, Carlos
===[https://www.amahi.org/apps/disk-wizard Disk Wizard ] ===
'''Description''': Expanding the storage capacity is an important feature of Amahi but . The DW is a critical part. However, it's not as stable as of now it requires advanced (eshould be.g. command line) skills. We want easy disk/It should detect more partition onboarding.Also add the ability to be asked to mount USB drives as a share types and handle everything gracefully, even when theyit can're connected & connect external shares from for example a NAS with the plugin system using that wizardt act upon certain configurations.
'''Objective''': Finish implementing Stability improvements and especially thoroughly testing an Amahi this plugin that will streamline the process by providing a UI for disk /partition 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
* [http://www.openmediavault.org/ OpenMediaVault] does have a nice wizard that people like
=== Amahi 9 and Amahi 10 ===
=== Amahi 12 === '''Description''': [[Amahi 9 and 10 are what's 12]] is our nextrelease. 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 8 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 45, 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 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.
 
'''Skills Required''': RoR, ruby, JS, CSS, HTML5, Bootstrap
'''Mentors''': Carlos, Rod ===Backup App Data and Settings=== '''Description''': When new versions of Amahi come out, a drawback of Amahi is that it's hard to backup the settings (e.g. partitioning) installed applications and their user dataSukhbir
'''ObjectiveReference''': The plugin should allow an administrator to backup any application data either on an external media or in the cloud(e.g.[https: 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//github.*Create an Amahi plugin that will allow backup and restore of the user data for apps installed from the AppStore*Centralizing app datacom/configs - link them to app folder instead.*"Destructive" update awareness*Ability to list, outline data directories for backupsamahi/upgrade checkplatform Amahi Platform repo]
== Android Mobile App==
Our mobile apps have streaming, browsing and sharing and it'''Skills Required''': System scriptings a great topic.
This year we'''Mentor''': Rod, Carlosre going to try emphasizing the Android app a little more.
==Mobile==
 
Mobile is a great topic and there are a lot of opportunities here within Amahi.
===Android App Improvements===
'''Description''': Add functionality or fix bug 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 Android appfollowing objectives:
'''Objectives''':
* UpdatesAndroid TV Revamp: update material The Android TV app is outdated at the moment and doesn't follow the latest designprinciples of Android. We have to redesign the app so that Amahi is accessible on Android TV again. Further, update deprecated (or soon we have to implement the PlayerAdapter in Android TV to be) calls, provide backwards compatibilitysupport previews.* Add Chromecast support Support for media playback (videos, audio and pictures)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.* Make Support for NAU: Complete the application compatible app with Android TV* Secondary user login support for Non-Admin User which currently exists on the appserver-side only. Ref: https://docs.google.com/presentation/d/1jZAdXpSGQRJ6xN2WCzqkiPxQPUW2VHsAnpENZKbT2z0* Add upload functionality, eUI Improvements and UI Testing: Adding an Expresso based automated UI testing protocol.g. automatically upload photos to your * Improve Background Service: Improve the app for uploading media on the HDAwhen the app isn't present in the foreground* Phone Auto-Backup: Develop a module that does an Auto backup your of the phone to your 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. 
'''Skills Required''': Java, Android framework
'''Mentors''': Carlos, BogdanChirag
'''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
 
 
'''Skills Required''': iOS programming
 
'''Mentors''': Carlos, Rod
 
'''Reference''': [https://www.amahi.org/ios Amahi iOS app]
 
=== Backend Improvements ===
'''Description''': One requested feature for our mobile app (iOS and later Android) is the ability to browse apps within our mobile app while remote. This is supported locally, but not remotely. Our server side of the app needs to be setup to proxy specific webapps that the user has installed. Collaboration with the iOS/Android devs will also be necessary to prototype it. Technically, this project consists of add functionality to our reference proxy (written in Go) to do transparent HTTP proxying for individual webapps separately. It's not a mobile project in the sense of being on a mobile OS.
 
'''Objective''': The following features need to be implemented:
* NPN negotiation, compliance to http/2
* More edge case tests.
* Server push
* Actual implementation of priorities (everything is one priority at the moment)
* Extensive error handling for all possible rainy-day scenarios specified in the specification
* Support for other than HTTP GET frames, i.e. POST, PUT or any request that has a body
Details can be found on [https://github.com/amahi/spdy#status SPDY].
 
'''Skills Required''': GO programming
 
==Reliability==
 
===CI Server for Apps===
 
'''Description''': App reliability is critical for Amahi. We have been striving to develop a customized CI (Continuous Integration) server for testing apps.
 
'''Objective''': Develop up a CI server for apps (we have been calling a prototype "the app grinder") . The goal is to achieve 100% app installation and reliability. An important goal is to support a tester program for Amahi. We have a number of ideas of what we want to achieve -- how to design the CI server so that testers can easily see their passes, failures and anything in between.
 
'''Skills Required''': Capybara, ruby, Webkit, Selenium, maybe Vagrant and system scripting. Other possible technologies could be Jenkins, Travis, etc.
 
'''Mentors''': Carlos, Bogdan
== Apps==
'''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''': Carlos, Rod
 
===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''': Carlos
===Create UI and package it for RSnapshot===
'''Skills Required''': RoR, system programming
'''Mentor''': Carlos, Rod, DagSukhbir
'''References'''
* [http://sourceforge.net/projects/rsnapshotbackup/ rsnapshot-backup-php]
* [http://dobrev.ws/projects/webrsnapshot Webrsnapshot]
 
===Package VoIP and/or PBX system===
 
'''Description''': A frequently requested application that is hard to package and configure is a voice over IP telephony app. Related to this is also a PBX system
 
'''Objective''': configuring PBX or a VoIP system can be complex. There are several hurdles to this. The task is to evaluate all
 
'''Skills Required''': app scripting and packaging, telephony, VoIP, messaging systems
 
'''Mentors''': Carlos, Pat
 
'''References''':
* [http://www.asterisk.org/ Asterisk]
* [http://www.freepbx.org/ FreePBX]
==Installer==
'''Mentors''': Carlos, Rod
===User Onboarding=Amahi Anywhere==
'''Description''': Help users get their HDA up The mobile apps use API endpoints provided by Amahi Anywhere for browsing, downloading and running with minimal interaction after installationstreaming files and more.
'''ObjectiveReferences''': Happier users. The idea is to implement an automated configuration check tool. The current * [httphttps://www.amahi.net org/apps/amahi-anywhere Amahi Interactive TroubleshooterAnywhere App] can be used as a starting point. The tool should:* check if the installation was successful* compare current settings against the expected settings* automatically fix inconsistencies with no user interaction '''Skills Required''': RoR, scripting, netflow capture, dhcping scripting '''Mentors''': Carlos, Rod ===Ubuntu 14.04=== '''Description''': Get Amahi ready for [https://wiki.ubuntugithub.com/TrustyTahramahi/ReleaseSchedule Ubuntu 14.04] '''Objective''': Further development on the Amahi platform to be able to install the same applications and have the same features as the Fedora based version. A new install CD package that allows you to add Amahi functionality to Ubuntu 14.04 (LTS) '''Skills Required''': ruby, ISO creation '''Mentor''': Carlos, Frans == Networking == ===Clustering Amahi Servers=== '''Description''': 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? '''Objective''': 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. '''Skills Required''': Ruby, misc system scripting '''Mentors''': Carlos ===Rolling Distribution=== '''Description''': Make -anywhere-specs Amahi a [https://en.wikipedia.org/wiki/Rolling_release rolling distributionAnywhere Specs'''Objective''': Being able to upgrade Amahi versions without having to upgrade OSs is very appealing and a huge win. '''Skills Required''': major Linux packaging mojo, ruby, system scripting, ISO packaging, repo creation '''Mentor''': Carlos
== GUI and UX =Improvements in AA File Server===
'''Description''': Amahi Anywhere File Server exposes HDA files and directories via REST APIs and also allows to upload new files
This area can offer '''a lotObjective''' of possibilities for ideas. A lot : Following features can be improved in Amahi to make the users happier. We are listing one topic here, but there are many, from a better front-end HTML (responsiveness, html5 compliance, browser compatibility, etc.), to CSS re-implementation, to allow for nice JS libraries to be used in plugins easily, like D3.js, Highcharts, etc., etc.implemented:
===* API to access platform apps over remote via proxy* Better Theme Integration===logging ([https://github.com/amahi/amahi-anywhere-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 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 enhanced experience
'''Description''': Our theme system is pretty good, however, it's very customized and we could do better with a more responsive front-end
'''ObjectiveSkills Required''':* allow the usage of popular themes out thereGoLang, like themes for Drupal, Wordpress, etc., with minor configuration changes, or even directly* allow the integration of mobile themes* provide hooks to detect mobile devices and present a mobile themeREST API Understanding
'''Mentors''': Carlos, Chirag
'''Skills RequiredReference''': CSS, HTML5, ruby, RoR[https://github.com/amahi/amahi-anywhere-fs/ Amahi Anywhere FS Github repo]
'''Mentors''': Carlos===Improvements in External Proxy===
=== Innovative Documentation ==='''Description''': External proxy provides API endpoints for users to remotely access Amahi Anywhere File Server
'''Objective''': Following features can be implemented:
'''Description''': Document * 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 in innovative ways, like screencasts, extra videos, hands-on guides, etc.Anywhere FS clients* Ability to ban a client
'''Objective''':
* Improve the way users get value from Amahi by instructing how to do typical operations
* It could be with screencasts, hand-on guides, videos, etc.
'''Skills Required''': management of teams, organization and documentationGoLang
'''Mentors''': Carlos, Chirag
=Other Ideas=
* Add features to our popular [http://www.amahi.org/ios Amahi app for iOS]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: Jesse and 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 7
* Integration of LDAP as a back-end management system, calendaring
* Feature development (examples):
* 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
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 GSoC admin): team lead for Amahi, experience in RoR, Go, Ruby, RoR, system scripting/development, app packaging, C, C++* Bogdan Mitrea (megabitdragon, CST, GSOC 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* Frans Meulenbroeks (eFfeMChirag Maheshwari, former GSoC student for Amahi* Kumar Shashwat, CET) ubuntuformer GSoC student for Amahi* Sukhbir Singh, armformer GSoC student for Amahi* Dipankar B. Amahi collaborator* Nitin V., FC21Amahi collaborator  Reference: [https://google.github.io/gsocguides/mentor/22GSoC mentoring page]. = Prior Years = Amahi participated in GSOC in 2020, C2019, 2018, Linux issues[[Google Summer of Code 2017]] 2016, networkingand [[Google Summer of Code 2014]]* Chris Pick == Prior Ideas (cpickNOT for 2021) == === iOS App Improvements === '''Description''': Amahi iOS app supports all basic functionalities including browsing files on HDA, PST)streaming audio/video, offline file access but still lacks a lot of features compared to its Android counterpart '''Objective''': Addition of new features and improvements in pre-existing ones in iOS appin swift to at least match or surpass the Android app '''Things to be implemented''': * Secondary user login* Chromecast support* Metadata display* Continuous music play* Upload and delete functionality* Thumbnail previews  '''Skills Required''': iOS programming, Swift '''Mentors''': Carlos, Chirag
'''Reference''': [httphttps://engithub.flossmanuals.netcom/GSoCMentoringamahi/ GSOC mentoring pageios Amahi 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]
1

edit