1pilotapp/symfony-client

1Pilot client for Symfony

Installs: 175

Dependents: 0

Suggesters: 0

Stars: 6

Watchers: 3

Forks: 0

Open Issues: 0

Type:symfony-bundle

1.0.0 2018-11-01 08:10 UTC

README

1Pilot.io - a universal dashboard to effortlessly manage all your sites

Latest Version on Packagist Software License Build Status Total Downloads

Website · Free Trial · Pricing · Documentation · API · Feedback · Support


[You] What are you, strange being?

[1Pilot] Greetings, traveller. I am 1Pilot. I am a tool created to monitor and manage earthbound Symfony applications.

[You] OK... What is your primary purpose?

[1Pilot] I was created to reduce the time you spend managing applications, so that you can focus on your primary mission.

[You] Wait, what? How could you know... What is my primary mission?

[1Pilot] My records indicate that your primary mission is ...searching database... to code in your underwear, jamming to Radiohead.

[You] 😲... 🤪... Sweet.

[1Pilot] Affirmative, traveller. ‘Sweet’.

... Initiating introduction protocol ...

Control all your applications from a single, powerful application monitoring tool.

  • Uptime monitoring - Get instant notifications about downtime and fix it before everyone else even knows it’s an issue.

  • SSL certificate monitoring - Keep track of certificates across all your applications and set reminders of their expiration dates.

  • Config file and server version monitoring - Be alerted when a config file is edited or when PHP, Database or WEB servers are updated.

  • Composer package management - See installed composer packages across all your applications and track their updates. Know exactly when new versions are available and log a central history of all changes.

  • Robust notification system - Get instant notifications across email, Slack and Discord. Too much? Then create fully customisable alerts and summaries for each function and comms channel at a frequency that suits you.

  • Full-featured 15-day trial - Then $2/site/month with volume discounts available. No setup fees. No long-term contracts.

... Introduction protocol complete ...

You have just discovered our advanced monitoring tool for your Symfony applications and all the individual sites that you manage. We have designed it as a central dashboard to harmonise the maintenance of your entire website roster. Because we believe that coders should be out there coding. Let computers monitor computers, so that we humans don’t have to worry about it.

We searched the galaxy for a robust answer to our challenges, and found none. So, our team embarked on our greatest mission yet and 1Pilot was born.

Try it for free without any limitations for 15 days. No credit card required.

Get your first site onboard in under 3 minutes! Start the 15-day full-feature trial

Install

composer require 1pilotapp/symfony-client --no-scripts

The no-scripts option is required to prevent errors, because you need to setup a few configuration parameters before being able to use the bundle.

Symfony 3

  1. add to your app/config/config.yml file the following configuration keys:

    one_pilot_client:
        private_key: "%one_pilot_private_key%"
        mail_from_address: "%one_pilot_mail_from_address%"
    
  2. add to your app/config/parameters.yml.dist file the following parameter:

        one_pilot_private_key: ~
        one_pilot_mail_from_address: ~
    

    This defines the new required configuration parameter.

  3. add to your app/config/parameters.yml file the following parameter:

        one_pilot_private_key: [your key]
        one_pilot_mail_from_address: [mail from address used by verification tool]
    

    one_pilot_private_key can be any random alphanumeric string. If you are not sure what key to use, go to 1Pilot dashboard and open the page to add a new site: a random key will be generated for you, and you can copy / paste it in your file. Of course you are free to create a totally different key, just make sure you have the same key in your parameters.yml and on the 1Pilot dashboard.

    one_pilot_email_check_from_address email address that you use for send mail from your application. It's used by the email verification tool for ensure emails are properly send by your application.

  4. add to your app/config/routing.yml the following configuration:

    one_pilot:
        resource: "@OnePilotClientBundle/Resources/config/routing.xml"
        prefix:   /
    
  5. add to your app/AppKernel.php file, in the registerBundles method, the following line:

    ...
    new OnePilot\ClientBundle\OnePilotClientBundle(),
    ...
    

You are now ready to add the site to your 1Pilot dashboard!

Symfony 4

  1. add a new config/packages/one_pilot_client.yaml file with the following content:

    one_pilot_client:
        private_key: "%env(ONE_PILOT_PRIVATE_KEY)%"
        mail_from_address: "%env(ONE_PILOT_MAIL_FROM_ADDRESS)%"
    
  2. add to your .env file the following parameters:

    ONE_PILOT_PRIVATE_KEY=[your key]
    ONE_PILOT_MAIL_FROM_ADDRESS: [mail from address used by verification tool]
    

    ONE_PILOT_PRIVATE_KEY can be any random alphanumeric string. If you are not sure what key to use, go to 1Pilot dashboard and open the page to add a new site: a random key will be generated for you, and you can copy / paste it in your file. Of course you are free to create a totally different key, just make sure you have the same key in your .env and on the 1Pilot dashboard.

    ONE_PILOT_MAIL_FROM_ADDRESS email address that you use for send mail from your application. It's used by the email verification tool for ensure emails are properly send by your application.

  3. add to your config/routes.yaml the following configuration:

    one_pilot:
        resource: "@OnePilotClientBundle/Resources/config/routing.xml"
        prefix:   /
    

You are now ready to add the site to your 1Pilot dashboard!

Advanced configuration

If your server is not at time you can have issue to connect your application to 1Pilot. For solve that edit app/config/config.yml and add skip_timestamp_validation like bellow.

one_pilot_client:
    private_key: "..."
    skip_timestamp_validation: true

Please note that this option will decrease security and that you should as much as possible set your server at the correct time.

Change log

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email support@1pilot.io instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.