Create an Import Badge

Remote Imports allow users to import entire servers and web content into Fenix. This is accomplished by producing an import badge, which can be displayed on websites, Github/BitBucket README pages and other places of distribution. Ultimately, an import badge is just a link to a prepared zip file.

The Fenix Deployment Wizard is the easiest way to create secure importable sites from sources like Github, Gists, BitBucket, Codepen, or any hosted zip file.

Wizard available at https://import.fenixwebserver.com

Supply a link, such as https://github.com/ngnjs/chassis-showroom, https://codepen.io/coreybutler/pen/WGazvE, or https://my-bucket.s3.amazonaws.com/path/to/site.zip.

2. Customize the Import

Providing a link from a known service (Github/Gists, BitBucket, Codepen) will pre-populate the import fields, all of which can be customized.

While most fields are self-explanatory, there are a few key fields to take note of:

Fenix Server Name

This is the default name that will show up in the web server settings unless the end user customizes it.

Screenshot URL

For known services, the screenshot URL is automatically determined. Some providers, like Github, do not provide a screenshot. In these cases, custom icons and avatars are used. This can be modified to use a custom image hosted at a custom URL.

Preferred Webroot Path

This is the path within the project root where the web content exists. By default, Fenix assumes this content is located in the project root. However, some projects have a different directory structure, such as src and dist subdirectories, representing the source code and a distributable "finished" or "built" version. In this case, /src may be a more appropriate webroot for end users who want to start working with the code.

Callback URL

The callback URL is a link where end users will be directed to upon completion of the import process. Common values for this include links to a README pages, build instructions, or even a thank-you page. This property exists to help developers offer a streamlined workflow for importing code, but it does not guarantee users will reach it. As shown in the Remote Imports approval process, end users have the option of automatically opening the new page, going to the callback URL, or ignoring both.

3. Copy Badge Code

Once the import is configured, a link is available. The code can be copied in markdown format (for README files), HTML code, or a URL. These options are available in the lower right corner of the screen.

Example Markdown Output
[![Import to Fenix](https://cdn.author.io/fenix/smallbadge.svg)](https://goo.gl/Rpyv1L\
Example HTML Output
<a href="https://goo.gl/QMKZdy"><img src="https://cdn.author.io/fenix/smallbadge.svg"/></a&gt;
Example URL Output
https://goo.gl/Rpyv1L

This code can be pasted into any hosted document or HTML page and shared with colleagues, friends, or the public.

That's all there is to it!

results matching ""

    No results matching ""