Twake icon indicating copy to clipboard operation
Twake copied to clipboard

Make connectors open source

Open RomaricMourgues opened this issue 5 years ago • 10 comments

Make a good plugin documentation and make things easy for contributors.

Currently nobody can create apps for Twake, it would be very nice if more apps are developed for Twake.

  • [x] Improve app creation process
  • [ ] Documentation "Get started"
  • [ ] Create a first app using tabs
  • [ ] Move all notion documentation to gitbook
  • [x] Move all connectors from gitlab to "builtInConnectors"

RomaricMourgues avatar Aug 11 '20 18:08 RomaricMourgues

Will connectors be opensource at least to have an example (as the documentation is not completely done yet) ?

Thanks in advance for your answer. :)

frju365 avatar Nov 27 '20 11:11 frju365

Hello,

Very interrested in connectors (Giphy, Onlyoffice, Polls). I would be happy to help (even on documentation proposal, in Frehch if needed :) ).

Thanks

jcastang avatar Dec 11 '20 09:12 jcastang

Hope to see n8n open source soon

dichvuhuuich avatar Dec 19 '20 01:12 dichvuhuuich

Also, very interested in connectors (Giphy, Onlyoffice, Polls).

gregb100 avatar Feb 02 '21 17:02 gregb100

@RomaricMourgues , is there any news on the documentation of the connectors? Much appreciated

vlude avatar May 07 '21 13:05 vlude

Hello @vlude I can tell you that the connectors are now open-sourced here: https://github.com/linagora/Twake-Connectors/ The documentation is still not online, I can try to explain how it works here a bit:

  1. You will notice that in the last release of Twake, in the file twake/docker-compose.yml.dist.onpremise there is a new volume for the php service - ./connectors/:/twake-core/src/BuiltInConnectors/Connectors. Please ensure you add this volume to your own docker-compose.yml.
  2. Download the connectors you would like to use in this new folder. It should looks like this: twake/connectors/Jitsi for instance.
  3. Some configuration must be done for every connector. You will find the default configuration in the ConnectorDefinition.php file under $configuration file for each Connector. You must not edit this configuration directly. Instead, you can edit your Parameters.php under defaults.connectors.{connector simple_name}.{configuration}. The connector simple name is also in ConnectorDefinition.php.
  4. Start Twake and run docker-compose exec php php bin/console twake:init_connector {connector simple_name} enable default
  5. If you edit any configuration in Parameters.php, you must disable the connector and enable it again.

Hope that can helps :)

RomaricMourgues avatar May 07 '21 14:05 RomaricMourgues

Hey Romaric, thanks for the guide. I'm going to try this very soon.

vlude avatar May 07 '21 20:05 vlude

i use docker-compose.dev.mongo.yml. i install the plagin https://github.com/linagora/Twake-Plugins-n8n. I did everything as in the instructions but the plugin did not appear on the site

sh1man999 avatar Nov 19 '22 21:11 sh1man999

Can someone help with the question above?

sh1man999 avatar Nov 20 '22 12:11 sh1man999

Hello @vlude I can tell you that the connectors are now open-sourced here: https://github.com/linagora/Twake-Connectors/ The documentation is still not online, I can try to explain how it works here a bit:

  1. You will notice that in the last release of Twake, in the file twake/docker-compose.yml.dist.onpremise there is a new volume for the php service - ./connectors/:/twake-core/src/BuiltInConnectors/Connectors. Please ensure you add this volume to your own docker-compose.yml.
  2. Download the connectors you would like to use in this new folder. It should looks like this: twake/connectors/Jitsi for instance.
  3. Some configuration must be done for every connector. You will find the default configuration in the ConnectorDefinition.php file under $configuration file for each Connector. You must not edit this configuration directly. Instead, you can edit your Parameters.php under defaults.connectors.{connector simple_name}.{configuration}. The connector simple name is also in ConnectorDefinition.php.
  4. Start Twake and run docker-compose exec php php bin/console twake:init_connector {connector simple_name} enable default
  5. If you edit any configuration in Parameters.php, you must disable the connector and enable it again.

Hope that can helps :)

I tried to run it, but it doesn't work. I see an empty onlyoffice icon image

sh1man999 avatar Nov 21 '22 01:11 sh1man999