Virtana / Documentation
Get started with your container.
Step-by-step guides: SSH key, connection, web publishing, ports, domains, backups and subscription.
01Create your SSH key
Your container has no password: you sign in with an SSH key pair. The private key stays on your computer. You only share the public key, a single line of text that starts with ssh-ed25519.
macOS and Linux
-
Open Terminal. On macOS: Applications › Utilities › Terminal.
-
Create the key. The text after
-Cis just a name to recognise it.ssh-keygen -t ed25519 -C "my-computer" -
Press Enter to accept the suggested location,
~/.ssh/id_ed25519. If the terminal offers to overwrite an existing key, answern: you already have a key, keep it. -
Choose a passphrase. It protects your key if someone copies the file; it is never sent to Virtana.
-
Display the public key and copy the whole line. On macOS,
pbcopy < ~/.ssh/id_ed25519.pubcopies it directly.cat ~/.ssh/id_ed25519.pub
Windows 10 and 11
-
Open PowerShell from the Start menu. If the
ssh-keygencommand is not found, add the optional feature “OpenSSH Client” in Windows settings. -
Create the key:
ssh-keygen -t ed25519 -C "my-pc" -
Press Enter to accept the suggested location,
C:\Users\your-name\.ssh\id_ed25519, then choose a passphrase. -
Copy the public key to the clipboard:
Get-Content $env:USERPROFILE\.ssh\id_ed25519.pub | Set-Clipboard
Using PuTTY? In PuTTYgen, choose the EdDSA (Ed25519) key type, click “Generate”, then copy the text from the “Public key for pasting into OpenSSH authorized_keys file” box.
Paste the key when ordering
In the configurator, paste the whole line into the “Public SSH key” field. Three formats are accepted: ssh-ed25519 (recommended), ssh-rsa and ecdsa-sha2-nistp256.
Never share the private key, the file without the .pub extension: not in the configurator, not with support.
Add or remove a key later
- On the container page, “Access and files” tab, the owner can add up to 20 keys, for example one per device, and remove those no longer used. The container must be running.
- The last key cannot be removed: add and test its replacement first. Removing a key does not close sessions that are already open.
- Lost your private key? Create a new key pair and add the new public key from this tab: the customer area needs no SSH access.
02Connect over SSH or SFTP
As soon as the container is delivered, its page shows the exact connection command, to its public IPv6 address, on port 22. If your connection has no IPv6, the page also gives a command through the instance’s name and its published port. A container without IPv6, in a project for example, is reached through an SSH port assigned to it: its command gives it with -p, and this port does not change.
-
Open My infrastructure, then your container page and the “Access and files” tab. The command also appears under “Overview”, with a button to copy it.
-
Paste it into your terminal. It looks like this:
ssh root@IPV6-ADDRESS -
On the first connection, the terminal shows the server fingerprint and asks you to confirm it: answer
yes. You are then asked for your passphrase if you set one.
If your key is not in the default location, point to it with -i:
ssh -i ~/.ssh/my-key root@IPV6-ADDRESSYou are signed in as root: the system is yours. Apply updates regularly, for example apt update && apt upgrade on Debian and Ubuntu.
Transfer files over SFTP
SFTP uses the same address, the same port, the root account and the same key. sftp and scp want the IPv6 address in brackets, and take a port with an upper-case -P.
sftp root@[IPV6-ADDRESS]scp site.zip root@[IPV6-ADDRESS]:/root/With software such as FileZilla, Cyberduck or WinSCP, choose the SFTP protocol, then enter the address, the port, the root user and your private key file.
Coming soonA web console and a file manager in the customer area. Until then, use SSH or SFTP.
Back to contents03Publish a web application
Each container gets its own HTTPS address: its name on our servers, v- followed by the first 12 characters of its identifier, then .instances.virtana.fr. It is shown under “Overview”. Virtana handles the certificate and forwards visits over HTTP to port 80 of your container.
-
Install a web server listening over HTTP on port 80. For example, on Debian or Ubuntu:
apt update && apt install -y nginx -
Check from the container that the page answers:
curl -I http://localhost -
Open the HTTPS address from “Overview” in your browser: your web server’s page appears.
Good to know
- Do not enable HTTPS on port 80 of the container: the encrypted connection ends at the Virtana relay, which then forwards over HTTP.
- Your application must listen on all interfaces (
0.0.0.0), not only on127.0.0.1. - An application listening on another port, such as 3000 or 8080: put a web server in front of it on port 80, or link a custom domain straight to that port (see Link a domain).
- Visits come from the Virtana relay: the visitor’s address is in the
X-Forwarded-Forheader. - Internet traffic is unlimited and free during launch.
04Add a public port
For a service that is not a website (game server, database, VPN…), open a public port. Containers share one IPv4 address: Virtana assigns a public port number and forwards it to the port of your choice in the container.
-
Start the container, then open the “Network and domains” tab.
-
Under “Public ports”, choose TCP or UDP and the port your service listens on in the container, then click “Add a port”.
-
The forwarding appears as
INSTANCE-NAME:PUBLIC-PORT → CONTAINER-PORT, with its status (IP-ADDRESS:PUBLIC-PORTfor a container without IPv6). It becomes active once the gateway has confirmed it: refresh the page after a few moments. -
Give this address to your users. Over IPv6, they also reach the service directly, at the container’s address and on its own port.
Good to know
- The number of included ports depends on the offer and is shown in this tab, on top of the SSH port. A TCP forwarding and a UDP forwarding each count as one port, even with the same number.
- Need more ports? The “port pack” option is chosen in the configurator when ordering, for a monthly supplement. It can also be added later, below the list of ports in this tab: you pay for what remains of the current period, then the supplement at each renewal.
- The public number is assigned automatically: you cannot reserve a specific number.
- The container firewall only accepts the ports declared here, on top of SSH and port 80.
- Stopping or suspending the container also cuts its forwardings. If a forwarding does not come back after a start, or after an error you have fixed, click “Synchronize access”.
Coming soonRemoving a port from the customer area, and IPv6.
Back to contents05Link a domain
Serve your application under your own name, for example app.example.com, with HTTPS handled by Virtana. A DNS TXT record first proves that the name is yours.
-
Start the container. In the “Network and domains” tab, “Custom domains” section, enter the full name and the container’s HTTP port (80 by default), then click “Add domain”.
-
At the domain’s DNS provider, create the two records shown under the name: a TXT
_virtana.app.example.comwith thevirtana=…value given, and an Aapp.example.compointing to the IPv4 address given. -
Wait until these records are visible, from a few minutes to a few hours depending on their time to live (TTL), then click “Verify DNS”.
-
Once the TXT is found, Virtana publishes the route and obtains the HTTPS certificate. The domain then becomes active.
Domain bought with your account, at OVH
If the domain is active in your account and registered at OVH, the “Configure DNS at OVH” button creates the address records and the TXT for you; you then only need to click “Verify DNS”. It never replaces an A, AAAA or CNAME record that points elsewhere: it reports the conflict, which you fix yourself. Your mail records are not changed.
Good to know
- Add each name separately:
example.comandwww.example.comare two domains. - Delete any AAAA (IPv6) record for this name: Virtana has no IPv6 yet and those visitors would not reach your container.
- Wildcard names such as
*.example.comare not supported. - Up to 20 domains per container. A name can be linked to only one container.
- As with the Virtana address, your application receives visits over HTTP on the port given, which is opened automatically in the container firewall.
06Buy a domain
Order a domain name from a container page. It is registered with OVHcloud for one year, then linked automatically to that container.
-
In the “Network and domains” tab, “Order a domain” section, enter the name you want, for example
example.com, then click “Check availability and price”. -
If it is available, the one-year price appears, excluding and including VAT. The quote is valid for one hour; nothing is bought at this stage.
-
Confirm your request, then pay by card with Stripe in the secure payment window. The card is saved for the yearly renewal; the shared balance cannot pay for a domain.
-
After payment, the domain is registered with OVHcloud. Virtana then links it to port 80 of your container, DNS and HTTPS included, with nothing to do on your side. Progress appears below the form.
Good to know
- Before your first purchase, your registrant details must be validated. If a message asks you to, open a ticket from your customer area.
- Some extensions that require specific documents cannot be ordered: the quote says so before any payment.
- Once the domain is registered, you can no longer exercise a right of withdrawal (terms of sale).
Renewal
- The domain renews automatically for one year. Its term is shown on its page, which you open from the “Order a domain” section of the “Network and domains” tab.
- 35 days before the term, you receive an email with the renewal price and the charge date.
- 14 days before the term, this price is charged to the card of your latest payment. If the charge fails, a second attempt takes place 7 days before, and you can pay by card on the domain page, “Pay for the renewal” button, until 3 days before the term.
- To decline the renewal, click “Turn off automatic renewal” on the domain page: nothing is charged and the domain expires at its term. You can turn it back on until 3 days before.
- Without payment by then, the domain is not renewed: it expires and may then be registered by someone else.
07Backups and restore
Each active container is backed up automatically once a day to a dedicated backup server. The last seven daily backups are kept.
View and start a backup
- The “Backups” tab lists backups with their date and status.
- “Create backup” starts an immediate backup, for example before a major update. It counts among the seven backups kept: the oldest are deleted as new ones arrive.
- A backup is also taken automatically before each reinstall.
- A suspended container, one in its retention period or busy with another operation is not backed up.
Restore a backup
-
Stop the container from “Overview”.
-
In “Backups”, under the chosen backup, type the exact container name to confirm, then click “Restore”.
-
The container disk is replaced by the backup: anything written after it is lost. Public access is cut during the operation.
-
At the end, the container stays stopped: start it from “Overview”.
Only the container owner can restore a backup.
Coming soonRestoring a backup into a new container.
Coming soonExporting a backup as an archive to download.
Keep your own copies
Virtana backups are a back-up service. Also keep your own copies, especially before cancelling. For example, from your computer:
scp -r root@[IPV6-ADDRESS]:/var/www ./www-copyComing soonInstant snapshots.
Back to contents08Change resources or reinstall
From the “Settings” tab of the container page, upgrade a container at any time, schedule a reduction for the renewal or start again from a fresh system.
Upgrade or change plan
-
In “Settings”, “Change resources” section, choose other processor, memory or disk tiers, or a higher plan, then click “Calculate the price”.
-
The price shown is the difference for the remaining days of the current period, excluding and including taxes, followed by the new renewal price.
-
Pay with “Pay with shared balance” or by card. The server’s capacity is checked before payment: if it is short, nothing is charged.
-
The resources are added within a minute or two, without a restart. An email confirms the change, with the invoice.
The file system grows with the disk. To check the new size:
df -h /Reduce
- Choose less processor or memory, then “Schedule the reduction”. The reduction takes effect at the next renewal, at the new price; the current period is not refunded.
- Until the renewal, “Cancel the reduction” cancels it.
- Disk size cannot be reduced, and a plan cannot be replaced by a lower plan.
- Before that date, make sure your applications fit in the new memory: beyond it, the system stops processes.
Reinstall the system
-
In “Settings”, “Reinstall the system” section, choose a distribution and type the exact container name to confirm.
-
A backup is taken first. The disk is then erased and the fresh system started, with the same IP address, ports, domains and HTTPS address, your current SSH keys and the firewall. Allow a few minutes; an email tells you when it is done.
-
To go back to the previous system, restore that backup from “Backups”.
-
Your computer reports that the SSH host key has changed: this is expected. Remove the old one, then connect again:
ssh-keygen -R IPV6-ADDRESS
Reinstalling is free and unlimited, one operation at a time. The full rules are in the terms of sale.
Back to contents09Renewal, balance, card and cancellation
Your container is a subscription paid in advance for one, three, six or twelve months, with a discount on longer periods. It renews for the same length, at the price in your contract.
Payment and renewal
- The first period is paid with the shared balance or online with Stripe. Each payment comes with an invoice, available in your customer area.
- The next renewal date appears under “Overview”.
- On the renewal date, the renewal is charged to your shared balance, common to the other services of the Newscloud suite, when it covers it. The balance is never topped up automatically: top it up in advance from My infrastructure, with the “Top up shared balance” link.
- When it does not cover it, your renewal card is charged, if you saved one. Without a saved card, no card is charged.
- An email reminds you of each renewal 7 days before. If you are a consumer, a three-, six- or twelve-month subscription also triggers an email, one to three months before its term, reminding you that you may choose not to renew it.
Renewal card
- It is optional. Tick “Renew automatically with this card” when you pay your order by card, or save one from the Billing page, “Renewal card” section, or from the “Settings” tab of the container page, “Renewal” sub-tab. You enter it on a secure Stripe page: Virtana never sees its number, only its brand, last four digits and expiry date.
- One card per account, for all your containers: saving another one replaces the previous one. It is only charged at a term your shared balance does not cover. An email confirms that it was saved.
- Remove it at any time with “Remove the card”: it is no longer charged and your renewals are paid from the shared balance again.
If the renewal is not paid
-
On the renewal date, an email lets you know, with a link to the container page to pay by card. You have a grace period: 2 days for a monthly subscription, 7 days for a quarterly one, 14 days for a half-yearly one and 30 days for a yearly one.
-
During this period, pay by card from the container page or top up your balance: the renewal then goes through automatically. A declined renewal card is charged again once a day; if your bank asks for a confirmation, pay from the container page.
-
Otherwise, the container is suspended: it is stopped and its access is cut. Its data is kept for 7 days.
-
During this retention, paying the renewal, by card from the container page or by topping up your balance, starts the container again automatically, with its data and access. The new period starts on the day of payment.
-
A final email warns you at least 24 hours before permanent deletion.
Stopping is not cancelling
Stopping the container changes neither the subscription nor its price: its resources stay reserved for you.
Cancel
-
On the container page, “Settings” tab, click “Cancel at period end”.
-
The container stays available until the end of the paid period, which is not refunded unless you exercise your right of withdrawal.
-
At the end, it is stopped and its data is kept for 7 days, then deleted after a final warning. Retrieve your data before the subscription ends.
Terminate immediately
-
Retrieve your data first: after the deletion, nothing can be restored, not even a backup.
-
On the container page, “Settings” tab, “Terminate now” section, type the exact name of the container to confirm, then click “Delete permanently”.
-
The container is stopped, then deleted with its disk, snapshots and backups. Its IP address, ports, HTTPS address, domain links and SSH keys are released. An email confirms the deletion and the container leaves your list of instances.
- Nothing is refunded: the paid period remains due until its end. The subscription is not renewed and a scheduled reduction is cancelled.
- Your orders and invoices remain available in your customer area.
- A domain bought for this container stays yours and keeps renewing according to its settings. You can link it to another container from that container’s “Network and domains” tab.
- If you are a consumer, the right of withdrawal remains a separate right for 14 days: it refunds you pro rata. To exercise it, write to support instead of terminating.
- Immediate termination is refused while another operation is in progress or under review on the container.
Cancel an order not delivered yet
-
Until the container is delivered, the “Cancel the order” section of the “Settings” tab replaces both terminations. Type the exact name of the container, then click “Cancel the order”.
-
A paid order is refunded in full and a credit note cancels its invoice. Paid with the shared balance, it is credited back to it. Paid by card, choose to receive it on your card (within 5 to 10 business days) or on your shared balance (at once): nothing is chosen in advance.
-
An unpaid order is simply cancelled, with nothing charged. An email confirms the cancellation and the container leaves your customer area; for a paid order, the invoice and its credit note stay in billing.
If the delivery has already started creating the container, or is under review, write to support: they delete what was created, then refund the order the same way.
The full rules are in the terms of sale.
Back to contents10Automate with the API
A JSON API lets your scripts list your containers, read their state, backups and measurements, and start, stop, restart or back them up. It works with a personal access token, created from your account.
- The full guide, with
curlexamples, is on the API page. - The OpenAPI 3.1 description is public: openapi.json.