ipfs/kubo

unix domain socket not removed if it exists

Open

#6,856 opened on Jan 31, 2020

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Go (2,725 forks)batch import
help wantedkind/enhancementtopic/rpc-api

Repository metrics

Stars
 (13,906 stars)
PR merge metrics
 (Avg merge 4d 2h) (28 merged PRs in 30d)

Description

When using a unix domain socket, config: "API": [ "/ip4/127.0.0.1/tcp/5001", "/unix/var/db/ipfs-go/socket/api.sock" ],

the first time it starts up, it works fine, but the second time it fails:

Error: serveHTTPApi: manet.Listen(/unix/var/db/ipfs-go/socket/api.sock) failed: listen unix /var/db/ipfs-go/socket/api.sock: bind: address already in use

It is common for programs to either use a lock file, or just simply remove it on start.

I've worked around the issue by removing it in my startup file, but a better solution that is more generic would be nice.

Contributor guide

Research direction
Investigate how to remove the existing Unix domain socket file before binding. Look at the startup code where the socket is created (likely in the API server setup). Add a check to delete the socket file if it exists before calling net.Listen.
Tech stack
go
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoUnix domain sockets
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75