Changes

From Amahi Wiki
Jump to: navigation, search
Updated Android App Improvements section.
 
 
'''Amahi is applying for hosting for GSoC 2017!'''
 
See the ideas below for GSoC 2017!
= 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 Raspberry Pi-style device with great I/O that can run 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 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
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 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 yourselfin a GH issue, saying you would like to do something, interact with the community =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
BUT First, Introduce yourself, interact with the community, so please [https://docs.google.com/forms/d/e/1FAIpQLSdATld5a5I0_ImhMn4LqV5kUChP-oTeNjQSqEMDCVdMjNeKLg1FAIpQLScP4Q2iSzLXCjz1gK2eNutO8IhX_PETXU2bL8pqmhe2t1nCqg/viewform?usp=send_form 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!
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")
 
'''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
 
'''Skills Required''': iOS programming
 
'''Mentors''': Carlos, Rod
 
'''Reference''': [https://www.amahi.org/ios Amahi iOS app]
== 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 10 ===
'''Description''': === Amahi 9 and 10 are 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!12 ===
'''ObjectiveDescription''': Work closely with the core team to define the features and functionality that we need to implement to get [[Amahi released. This project 12]] 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 cloudour next release. Features:
* fully convert '''Objective''': Work closely with the front-end core team to bootstrap define the features and make sure functionality that we can install bootstrap themes need to implement to get Amahi released. This project is about working on RoR and have the Amahi platform core. Some of the core technology will need to be upgraded, like Rails 5, latest Phusion Passenger, possibly replace MySQL for the platform, create a consistent native API to the platform that can be used by other apps, like mobile apps. Other ideas include beefing up security and responsive look and behaviorprovide support for Amahi hosting on the cloud. Features: * 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, Sukhbir
===Backup App Data and Settings==='''Reference''': [https://github.com/amahi/platform Amahi Platform repo]
'''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 data== Android Mobile App==
'''Objective''': 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.*Create an Amahi plugin that will allow backup and restore of the user data for apps installed from the AppStore*Centralizing app data/configs - link them to app folder instead's a great topic.*"Destructive" update awareness*Ability to list, outline data directories for backups/upgrade check
This year we're going to try emphasizing the Android app a little more.
'''Skills Required''': System scripting
'''Mentor''': Rod, Carlos===Android App Improvements===
=== Backend Improvements ==='''Description''': One requested feature for our mobile app (iOS and later Amahi Android) is offers the ability to browse apps within our mobile app while remote. This is supported locallystream your HDA over your Android phone and Android TV, but not remotely. Our server side support for Chromecast and auto-upload 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 images to prototype itHDA. Technically, this project consists of add functionality to our reference proxy (written in Go) The next step is to do transparent HTTP proxying for individual webapps separately. It's not a mobile project in complete the sense of being on a mobile OS.following objectives:
'''ObjectiveObjectives''': 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
* 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.
Details can be found on [https://github.com/amahi/spdy#status SPDY].
'''Skills Required''': Go programmingJava, Android framework
==Reliability=='''Mentors''': Carlos, Chirag
===CI Server for Apps=== '''DescriptionReference''': App reliability is critical for Amahi. We have been striving to develop a customized CI (Continuous Integration) server for testing apps. '''Objective'''[https: 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//github. An important goal is to support a tester program for com/amahi/android 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, BogdanAndroid Github repo]
== 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
'''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, Sukhbir
'''References'''
'''Mentors''': Carlos, Rod
===User Onboarding=Amahi Anywhere== The mobile apps use API endpoints provided by Amahi Anywhere for browsing, downloading and streaming files and more. '''References''':* [https://www.amahi.org/apps/amahi-anywhere Amahi Anywhere App]* [https://github.com/amahi/amahi-anywhere-specs Amahi Anywhere Specs]
'''Description''': Help users get their HDA up and running with minimal interaction after installation===Improvements in AA File Server===
'''ObjectiveDescription''': Happier users. The idea is Amahi Anywhere File Server exposes HDA files and directories via REST APIs and also allows to implement an automated configuration check tool. The current [http://www.amahi.net Amahi Interactive Troubleshooter] 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 interactionupload new files
'''Objective''': Following features can be implemented:
'''Skills Required'''* API to access platform apps over remote via proxy* Better logging ([https: RoR//github.com/amahi/amahi-anywhere-fs/issues/4 Issue #4])* Simplistic dashboard to view some metrics like number of users connected, scriptingaccess logs for each user, netflow capturesystem health etc.* API to fetch metadata (duration, dhcping scriptingcodec, 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
'''Mentors''': Carlos, Rod
'''Skills Required''': GoLang, REST API Understanding '''Mentors''': Carlos, Chirag '''Reference''': [https://github.com/amahi/amahi-anywhere-fs/ Amahi Anywhere FS Github repo] ===Ubuntu 14.04Improvements in External Proxy=== '''Description''': External proxy provides API endpoints for users to remotely access Amahi Anywhere File Server
'''DescriptionObjective''': Get Amahi ready for [httpsFollowing features can be implemented://wiki.ubuntu.com/TrustyTahr/ReleaseSchedule Ubuntu 14.04]
'''Objective''': Further development on the Amahi platform * Cache implementation for chunks of files passing frequently through proxy to be able speed up response and save bandwidth* Dashboard to install the same applications view metrics on both connected mobile and have the same features as the Fedora based version. A new install CD package that allows you to add Amahi functionality Anywhere FS clients* Ability to Ubuntu 14.04 (LTS)ban a client
'''Skills Required''': ruby, ISO creation
'''MentorSkills Required''': Carlos, FransGoLang
== Networking =='''Mentors''': Carlos, Chirag
=Other Ideas=
* 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
 
Plus, of course we are open to suggestions. Open a dialog. We're happy to discuss and determine a suitable project.
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* 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  Reference: [https://google.github.io/gsocguides/mentor/ GSoC mentoring page]. = Prior Years = Amahi participated in GSOC in 2020, 2019, 2018, [[Google Summer of Code 2017]] 2016, and [[Google Summer of Code 2014]] == 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 '''Objective''': Addition of new features and improvements in pre-existing ones in iOS app in 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