Apertium-apy/Fedora - Revision history

Tino Didriksen: wget -> curl

2021-04-02T21:02:09Z

wget -> curl

Sushain at 01:43, 8 March 2018

2018-03-08T01:43:07Z

Unhammer: /* Quickstart */

2017-01-17T08:07:33Z

Quickstart

Unhammer at 11:31, 30 November 2016

2016-11-30T11:31:49Z

Unhammer at 11:31, 30 November 2016

2016-11-30T11:31:10Z

Unhammer at 11:30, 30 November 2016

2016-11-30T11:30:45Z

Unhammer: fedora

2016-11-30T11:29:02Z

fedora

New page

This is a quickstart guide to setting up your very own Apertium API server on Fedora.

==Why?==
Running your own API server means
* you get to decide what kinds of crazy half-finished language pairs to serve (or you can just serve a few of the high-quality ones that you like)
* you can run Apertium within your super-fortified network without your highly confidential translations touching anyone else's computer
* you don't have to worry about anyone else's API server going down right when you need it the most
* you have control over how many concurrent apertium processes you run (if your site or program calls plain `apertium` on each request, you can easily overload your server)

{{TOCD}}

==Quickstart==

Add the RPM repo:
<pre>
wget http://apertium.projectjj.com/rpm/install-nightly.sh
sudo bash install-nightly.sh
</pre>
Now install APY and the language pairs you want:
<pre>
sudo dnf clean metadata
sudo dnf upgrade -y
sudo dnf install apertium-apy
sudo dnf install apertium-eng-kaz apertium-sme-nob apertium-hbs-mkd apertium-eo-en apertium-tat-rus # etc.
</pre>
(Here we're assuming you only want packaged pairs, see [[Installation]] on how to install SVN pairs.)

You can now start APY like this:
<pre>
sudo systemctl start apertium-apy
</pre>

and enable it for starting after a reboot like this:
<pre>
sudo systemctl enable apertium-apy
</pre>

==Test that it works==
You can do
<pre>
sudo systemctl status apertium-apy
</pre>
and it should show something like
<pre>
● apertium-apy.service - Apertium APY service
Loaded: loaded (/lib/systemd/system/apertium-apy.service; disabled; vendor preset: enabled)
Active: active (running) since må. 2016-06-13 11:38:10 CEST; 3s ago
Docs: http://wiki.apertium.org/wiki/Apertium-apy
Main PID: 14813 (python3)
CGroup: /system.slice/apertium-apy.service
└─14813 /usr/bin/python3 servlet.py /usr/share/apertium/modes

juni 13 11:38:10 gamlepadda systemd[1]: Started Apertium APY service.
juni 13 11:38:11 gamlepadda python3[14813]: [W 160613 11:38:11 servlet:865] Unable to import CLD2, continuing using naive method of lang
juni 13 11:38:11 gamlepadda python3[14813]: [I 160613 11:38:11 servlet:792] 7 pair modes found
juni 13 11:38:11 gamlepadda python3[14813]: [I 160613 11:38:11 servlet:792] 0 analyzer modes found
juni 13 11:38:11 gamlepadda python3[14813]: [I 160613 11:38:11 servlet:792] 0 generator modes found
juni 13 11:38:11 gamlepadda python3[14813]: [I 160613 11:38:11 servlet:792] 0 tagger modes found
juni 13 11:38:11 gamlepadda python3[14813]: [I 160613 11:38:11 servlet:898] Serving at http://localhost:2737
</pre>
if it's started. (Press q to get your terminal back if it put you in less-mode.)

Try checking what language data it found:
<pre>
curl http://localhost:2737/listPairs
</pre>

It should contain a list of pairs.

Say the list contains <code>{"sourceLanguage": "sme", "targetLanguage": "nob"}</code>, then we can try translating the sentence "in leat doppe" from sme to nob:
<pre>
curl 'http://localhost:2737/translate?langpair=sme|nob&q=in+leat+doppe'
</pre>
That should give something like <code>{"responseData": {"translatedText": "jeg er ikke der borte"}, "responseDetails": null, "responseStatus": 200}
</code>.

If everything worked, congrats, you have your own Apertium API server running!

Now open port 2737 in your [[#Firewall|firewall]] and point your [[apertium-html-tools|website]] or [[Android|app]] at it :-)

If you ran into trouble, please ask for help on [[IRC]] or the [[Contact|mailing list]].

==If you don't have/want root==
See [[Apertium-apy#Running_as_a_--user_unit]].

==Firewall==
To open ports permanently in a Fedora server running firewalld, do:

<pre>
sudo firewall-cmd --permanent --new-service=apy
sudo vim /etc/firewalld/services/apy.xml
</pre>
paste this into the file:
<pre>
<?xml version="1.0" encoding="utf-8"?>
<service>
<short>APY Apertium MT Server</short>
<description>APY is an API server for the Apertium Machine Translation Platform, written in Python. See http://wiki.apertium.org/wiki/Apertium-apy or https://github.com/goavki/apertium-apy/ for more information.</description>
<port protocol="tcp" port="2737"/>
</service>
</pre>

Then do:
<pre>
sudo firewall-cmd --permanent --add-service=apy
sudo firewall-cmd --reload
</pre>

==More info==
See [[Apertium-apy]] for other things you can do with Apy and more documentation.

[[Category:Tools]]
[[Category:Installation]]
[[Category:Documentation in English]]
[[Category:Quickstart]]

@@ Line 1: / Line 1: @@
 This is a quickstart guide to setting up your very own Apertium API server on Fedora.
-(http://gtweb.uit.no/jorgal runs a fork of APY on Fedora; the systemd unit there is called "apy", not "apertium-apy", see [[Jorgal]].)
 ==Why?==
@@ Line 115: / Line 114: @@
 </pre>
+==Jorgal==
+http://gtweb.uit.no/jorgal runs a fork of APY on Fedora; the systemd unit there is called "apy", not "apertium-apy", see [[Jorgal]].
 ==More info==

@@ Line 1: / Line 1: @@
 This is a quickstart guide to setting up your very own Apertium API server on Fedora.
-(http://gtweb.uit.no/jorgal runs a fork of APY on Fedora; the systemd unit there is called "apy").
+(http://gtweb.uit.no/jorgal runs a fork of APY on Fedora; the systemd unit there is called "apy", not "apertium-apy", see [[Jorgal]].)
 ==Why?==

@@ Line 16: / Line 16: @@
 Add the RPM repo:
 <pre>
-wget http://apertium.projectjj.com/rpm/install-nightly.sh
+curl -sS https://apertium.projectjj.com/rpm/install-nightly.sh | sudo bash
-sudo bash install-nightly.sh
 </pre>
 Now install APY and the language pairs you want:

@@ Line 103: / Line 103: @@
 <service>
   <short>APY Apertium MT Server</short>
-  <description>APY is an API server for the Apertium Machine Translation Platform, written in Python. See http://wiki.apertium.org/wiki/Apertium-apy or https://github.com/goavki/apertium-apy/ for more information.</description>
+  <description>APY is an API server for the Apertium Machine Translation Platform, written in Python. See http://wiki.apertium.org/wiki/Apertium-apy or https://github.com/apertium/apertium-apy/ for more information.</description>
   <port protocol="tcp" port="2737"/>
 </service>

@@ Line 26: / Line 26: @@
 sudo dnf install apertium-eng-kaz apertium-sme-nob apertium-hbs-mkd apertium-eo-en apertium-tat-rus # etc.
 </pre>
-(Here we're assuming you only want packaged pairs, see [[Installation]] on how to install SVN pairs.)
+(Here we're assuming you only want packaged pairs, see [[Installation]] on how to install pairs that are only in SVN.)